caliper-php is a php client for Caliper that provides an implementation of the Caliper SensorAPI™.
- PHP 5.4 required (PHP 5.6 recommended)
- Ensure you have php5 and php5-json installed:
sudo apt-get install php5 php5-json - Install Composer (for dependency management):
curl -sS https://getcomposer.org/installer | php - Install dependencies:
php composer.phar install - Run tests using the Makefile
To install the library, clone the repository from GitHub into your desired application directory.
git clone https://github.com/IMSGlobal/caliper-php.git
Then, add the following to your PHP script:
require_once '/path/to/caliper-php/lib/CaliperSensor.php';
Now you're ready to initialize Caliper and send an event as follows:
Caliper::init('org.imsglobal.caliper.php.apikey', [
'debug' => true,
'host' => 'example.org',
'port' => 80,
'sendURI' => '/dataStoreURI',
]);
// TODO: Define $yourCaliperEventObject
Caliper::send($yourCaliperEventObject);
Your PHP program should call init() only once, when it responds to a request. All parts of your program will then have access to the same Caliper client.
A simple example program can be found in:
examples/SessionEventSampleApp.php
It will attempt to send an event to a data store listener on localhost:8000. If you have a data store on some other host or port, you can edit the program to point to it. If you don't have a data store, you can run a simple listener included in:
examples/tools/testListener.sh [optional_port]
That will start a simple PHP web server (on port 8000 by default) that listens for POST requests and dumps the raw contents to the terminal. If you run this in one terminal window and the example program in another terminal window, you will see the request received in the first window.
Documentation is available at http://www.imsglobal.org/caliper.
A very special thank you to each of the developers that contributed to this project:
- Prashant Nayak, Intellify Learning
- balachandiran.v / Yoganand-htc
- Lance E Sloan (lsloan at umich dot edu), University of Michigan
©2015 IMS Global Learning Consortium, Inc. All Rights Reserved. Trademark Information - http://www.imsglobal.org/copyright.html
For license information contact, info@imsglobal.org and read the LICENSE file contained in the repository.