README.md

SOCS PHP

This is a PHP wrapper for the SOCS XML feeds.

If you find this useful...

This package was developed by Fred Bradley, a developer at Cranleigh School and Cranleigh Prep School. If you find it useful, I'd really appreciate a tweet to let me know. Or even better, feel free to fund further developments.

Installation

You can install the package via composer:

composer require fredbradley/socs-php

Example Usage

$config = new FredBradley\SOCS\Config($socsId, $apiKey);
$socs = new FredBradley\SOCS\CoCurricular($config);

// Get All Clubs from CoCurricular
$clubs = $socs->getClubs();
// Get all Events from CoCurricular
$events = $socs->getEvents();

// ... more documentation to follow

Full docs will be released soon.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Fred Bradley
• All Contributors

License

The MIT License (MIT). Please see License File for more information.