TinCanPHP

Supported API Versions

1.0.1, 1.0.0

Basic Usage

The following samples show the basic usage of TinCanPHP.

All samples assume that a $lrs object has already been created with the proper endpoint and credentials to connect to the LRS.

$lrs = new TinCan\RemoteLRS(
    'https://cloud.scorm.com/tc/public/',
    '1.0.1',
    '<Test Username>',
    '<Test Password>'
);

Sample sending of a statement and checking for successful response:

$actor = new TinCan\Agent(
    [ 'mbox' => 'mailto:info@tincanapi.com' ]
);
$verb = new TinCan\Verb(
    [ 'id' => 'http://adlnet.gov/expapi/verbs/experienced' ]
);
$activity = new TinCan\Activity(
    [ 'id' => 'http://rusticisoftware.github.com/TinCanPHP' ]
);
$statement = new TinCan\Statement(
    [
        'actor' => $actor,
        'verb'  => $verb,
        'object' => $activity,
    ]
);

$response = $lrs->saveStatement($statement);
if ($response->success) {
    print "Statement sent successfully!\n";
}
else {
    print "Error statement not sent: " . $response->content . "\n";
}

Alternatively most interfaces that take a specific type of object can also be passed an array that will be materialized into the particular type of object. This allows for easier creation of simplified calls, such as sending a statement without pre-composing the objects. Such as:

$response = $lrs->saveStatement(
    [
        'actor' => [
            'mbox' => 'info@tincanapi.com',
        ],
        'verb' => [
            'id' => 'http://adlnet.gov/expapi/verbs/experienced',
        ],
        'object' => [
            'id' => 'http://rusticisoftware.github.com/TinCanPHP',
        ],
    ]
);

The various parts of the Statement structure can also be instantiated using the fromJSON method as a factory. For instance given a string of JSON representing an Agent we can get an instance of the TinCan\Agent class by doing:

$stringOfJSON = '{"mbox":"mailto:info@tincanapi.com"}';

$agent = TinCan\Agent::fromJSON($stringOfJSON);

The opposite is also true, given an instance of one of the model structures a serialized representation of that model for encoding as JSON can be retrieved using the asVersion method. The asVersion method takes an optional string argument indicating the version of the specification used for serialization defaulting to the latest supported by the library. Such as:

$serialized = $agent->asVersion();

print json_encode($serialized);

All objects provide a get/set interface for their properties, and in most cases the setter can be chained. So we can construct an Activity like:

$activity = new TinCan\Activity();
$activity
    ->setId('http://rusticisoftware.github.com/TinCanPHP')
    ->setDefinition([]);

$activity->getDefinition()
    ->setType('http://activitystrea.ms/schema/1.0/page')
    ->getName()
    ->set('en-US', 'TinCanPHP Homepage');

Sample of working with the document APIs, in particular the State API.

$saveResponse = $lrs->saveState(
    $activity,
    $agent,
    'testDocument',
    'someValue'
);
if ($saveResponse->success) {
    $retrieveResponse = $lrs->retrieveState(
        $activity,
        $agent,
        'testDocument'
    );
    if ($retrieveResponse->success) {
        print $retrieveResponse->content; // 'someValue'

        $deleteResponse = $lrs->deleteState($activity, $agent, 'testDocument');
    }
}