Tin Can API Library

Installs: 1 043

Dependents: 2

Stars: 32

Watchers: 29

Forks: 25

Open Issues: 14

Language: PHP

0.12.0 2015-01-15 16:36 UTC

README

A PHP library for implementing Tin Can API.

Build Status

For hosted API documentation, basic usage instructions, supported version listing, etc. visit the main project website at:

http://rusticisoftware.github.io/TinCanPHP/

For more information about the Tin Can API visit:

http://tincanapi.com/

Requires PHP 5.4 or later. (If you must run something older you should look at the PHP_5_2 branch.)

Installation

TinCanPHP is available via Composer.

php composer.phar require rusticisoftware/tincan:@stable

When not using Composer, require the autoloader:

require 'path/to/TinCan/autoload.php';

Testing

Tests are implemented using PHPUnit. Configure the LRS endpoint and credentials by copying the tests/Config.php.template to tests/Config.php then setting the values for your LRS.

Once configured run:

phpunit tests

API Doc Generation

Documentation can be output using phpDocumentor2. It will be installed when using Composer. To generate documentation:

./vendor/bin/phpdoc.php

From the root of the repository after running php composer.phar update. Documentation will be output to doc/api.

If you do not have the default timezone set in your php.ini file you can create one in the base of the repo and use the PHPRC environment variable to point to it. Use something like:

export PHPRC="/path/to/repos/TinCanPHP/php.ini"

And set the timezone in that file using:

[PHP]

date.timezone = "US/Central"

Certificate Generation

These instructions are for creating the requisite public/private key pair and certificate on a Mac with OpenSSL installed. See https://www.openssl.org/docs/HOWTO/certificates.txt and https://www.openssl.org/docs/HOWTO/keys.txt.

Generate a private key (which contains a public key) without a password (not recommended):

openssl genrsa -out privkey.pem 2048

To generate a private key with a password:

openssl genrsa -des3 -out privkey.pem 2048

Create a certificate signing request:

 openssl req -new -key privkey.pem -out cert.csr

To create a self signed certificate (as opposed to one signed by a CA), primarily for testing purposes:

openssl req -new -x509 -key privkey.pem -out cacert.pem -days 1095