activity_profile.md

The Activity Profile API

Activity Profiles

A LMS can use the xAPI to store documents associated to a certain activity using activity profiles. An activity profile is dedicated to an activity and a profile id:

use Xabbuh\XApi\Model\ActivityProfile;

// ...
$profile = new ActivityProfile();
$profile->setActivity($activity);
$profile->setProfileId($profileId);

Documents

Documents are simple collections of key-value pairs and can be accessed like arrays:

use Xabbuh\XApi\Model\ActivityProfileDocument;

// ...
$document = new ActivityProfileDocument();
$document->setActivityProfile($profile);
$document['x'] = 'foo';
$document['y'] = 'bar';

Obtaining the Activity Profile API Client

After you have built the global xAPI client, you can obtain an activity profile API client by calling its getActivityProfileApiClient() method:

$activityProfileApiClient = $xApiClient->getActivityProfileApiClient();

Storing Activity Profile Documents

You can simply store an ActivityProfileDocument passing it to the createOrUpdateActivityProfileDocument() method of the xAPI client:

$document = ...; // the activity profile document
$activityProfileApiClient->createOrUpdateActivityProfileDocument($document);

If a document already exists for this activity profile, the existing document will be updated. This means that new fields will be updated, existing fields that are included in the new document will be overwritten and existing fields that are not included in the new document will be kept as they are.

If you want to replace a document, use the createOrReplaceActivityProfileDocument() method instead:

$document = ...; // the activity profile document
$activityProfileApiClient->createOrReplaceActivityProfileDocument($document);

Deleting Activity Profile Documents

An ActivityProfileDocument is deleted by passing the particular ActivityProfile to the deleteActivityProfileDocument() method:

$profile = ...; // the activity profile the document should be deleted from
$activityProfileApiClient->deleteActivityProfileDocument($profile);

Retrieving Activity Profile Documents

Similarly, you receive a document for a particular activity profile by passing the profile to the getActivityProfileDocument() method:

$profile = ...; // the activity profile the document should be retrieved from
$document = $activityProfileApiClient->getActivityProfileDocument($profile);