README

with Laravel Discovery Support

STEER Education are in the process of developing an API to access the assessment results for pupils. I am helping them with this as we have already many of the building blocks in place with Cranleigh School's Pastoral Module.

This package is a PHP wrapper to the STEER API. Any suggestions or improvements are welcome both in terms of data output and the fluency of interacting with the code.

Installation & Requirements

This package requires PHP 8.2 and above.

You can install the package via composer:

composer require fredbradley/php-steer-api

Usage

If within a Laravel Application with Laravel Discovery turned on

You will need to add the following to your .env file:

STEER_API_KEY=
STEER_SUBSCRIPTION_KEY=
STEER_BASE_URL=

The config file is publishable, but you shouldn't need to change anything.

Dependency Injection

The package will automatically register the SteerConnector class as a singleton. You can then use the SteerConnector class as a dependency in your classes.

Facade

There is a facade that goes with the package if that's how you choose to work. Example:

use FredBradley\PhpSteerApi\Facades\Steer;
use FredBradley\PhpSteerApi\QueryBuilder;

// Set the Query Builder
$query = (new QueryBuilder())->setYear(2022);
// Get the Data
$data = Steer::getAssessmentData($query)->object();

If using as a standalone package in any PHP application

$service = new \FredBradley\PhpSteerApi\SteerConnector($apiKey, $subscriptionKey, $baseUrl);
$service
  ->getAssessmentData(
    filters: [
      "house" => "Hufflepuff",
      "year" => 10
    ],
    year: 2019
  )
  ->object();

This will return an object with a data property which is an array of objects. Each object is the STEER tracking assessment result.

The second argument in getAssessmentData (year) is optional and will default to the current academic year if not set. The STEER API carries data for 5 yars.

Filters available are:

house - filter by house name
campus - filter by campus name
year - filter by year group
mis_id - filter by pupil's MIS ID
gender - filter by gender (desired value is m or f)
round - filter by round (as in the round of assessment)

With no filters set, the API will return all results for the current academic year.

See the example output here.

This package uses the Saloon API package to make the HTTP requests. You can read more about that package here.

Caching

By default the package will cache unique results (based on query) for 10 minutes. It uses the Local Filesystem cache driver from Saloon. You can read more about that here.

Testing

composer pest

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email code@fredbradley.co.uk instead of using the issue tracker.

Credits

License

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

fredbradley / php-steer-api

Maintainers

Details