Clever PHP library
PHP
Latest commit e1b93e9 May 25, 2017 @meliaj meliaj Fix tests

README.md

clever-php

Build Status

Maintenance

Clever is moving to a community supported model with our client libraries. We will still respond to and merge incoming PRs but are looking to turn over ownership of these libraries to the community. If you are interested, please contact our partner-engineering team at tech-support@clever.com.

Installation

Download the latest version of the Clever PHP library via git:

git clone https://github.com/Clever/clever-php

or click here: https://github.com/Clever/clever-php/tarball/master.

Composer Support

Composer support has been added, Place the following lines in your composer.json file.

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/clever/clever-php"
        }
    ],
    "require": {
       "clever/clever": "*"
}
}

Note that it is necessary to include the vcs link to be sure that you are pulling from this repo.

The package manager for composer currently does not point to the correct repo for clever/clever-php.

We are published as clever/clever.

Usage

If you haven't already, install Composer:

curl -sS https://getcomposer.org/installer | php

Then use composer to install dependencies:

php composer.phar install --prefer-dist --no-interaction --no-progress

Then add the following to your PHP script:

require_once("/path/to/clever-php/lib/Clever.php");
require_once('/path/to/clever-php/vendor/autoload.php');

To authenticate using your API token, call setToken:

Clever::setToken("TOKEN_STRING");

Once you've included Clever.php and set your API token, you can begin using the objects provided by the SDK:

  • CleverDistrict
  • CleverSchool
  • CleverStudent
  • CleverSection
  • CleverTeacher
  • CleverSchoolAdmin
  • CleverEvent

These objects correspond directly with the endpoints of the REST API, and expose the exact same functionality via the class methods all() and retrieve():

CleverSchool::all(); // gets the schools you have access to via your API token.
CleverSchools::retrieve($id); // gets school with ID $id

all() returns an array of Clever objects, while retrieve() returns a single instance of an object. Each Clever object has an additional set of instance methods corresponding to "second-level" information. For example, getting all of the schools, teachers, students, and sections for a district could be done like so:

$demo_district = CleverDistrict::retrieve("4fd43cc56d11340000000005");
$demo_schools = $demo_district->schools();
$demo_teachers = $demo_district->teachers();
$demo_students = $demo_district->students();
$demo_sections = $demo_district->sections();

The same patterns apply to other Clever objects (CleverSchool, CleverStudent, CleverSection, CleverTeacher, CleverSchoolAdmin, and CleverEvent). Here's an example that gets information about a teacher, all the sections they teach, the school they belong to, and the students they teach:

$teacher = CleverTeacher::retrieve("4fee004dca2e43cf270007d5");
$teacher_sections = $teacher->sections();
$teacher_school = $teacher->school();
$teacher_students = $teacher->students();

Query Parameters

Most API requests allow query parameters for purposes like paging and filtering. The same can be done in the PHP library by passing the all() method an associative array of parameters. For example, to retrieve the last Event from the Events API, you could run:

$events = CleverEvent::all(array('ending_before' => 'last', 'limit' => 1));

To cursor through larger data sets, capture the last ID of an object in a set, and use it as the starting_after value for a subsequent request.

$schools = CleverSchool::all(array('limit' => 1)); # page "one"
$last_school = $schools[count($schools)-1];
do {
  # retrieve page "two" and beyond
  $more_schools = CleverSchool::all(array('limit' => 1, 'starting_after' => $last_school->id));
  if(count($more_schools) > 0) {
    $schools = array_merge($schools, $more_schools);
    $last_school = $more_schools[count($more_schools)-1];
  } else {
    $last_school = NULL;
  }
} while($last_school);
print_r($schools); # Print all the schools retrieved.

To cursor to a previous page, use the first ID of each set as the ending_before value.

Unfortunately, paginating via relative links is not yet supported by clever-php.

Testing

It's easy to run clever-php's tests after obtaining its dependencies.

First install Composer if you have not already:

curl -sS https://getcomposer.org/installer | php

Then use composer to install dependencies:

php composer.phar install --prefer-dist --no-interaction --no-progress

And now you can run the tests with phpunit:

./vendor/bin/phpunit

Publishing

  1. Update CHANGELOG
  2. git tag -a vX.X.X
  3. git push --tags origin HEAD:master
  4. Log into Packagist (credentials are in 1PFT) and click "Update"

Previous Versions

The current client supports v1.2 of the API. For v1.1 please use:

https://github.com/Clever/clever-php/tree/v0.5.0

Feedback

Questions, feature requests, or feedback of any kind is always welcome! We're available at tech-support@clever.com.