canaltp/tyr-component

PHP library which makes curl calls to Tyr API.

1.3.2 2017-02-20 14:55 UTC

Requires

• php: >=5.2
• guzzle/guzzle: ^3.8.1

Requires (Dev)

• phpunit/phpunit: ~4.3

Suggests

• guzzlehttp/guzzle: >=5.0 <6.0

GPL-3.0

• php
• tyr

README

PHP library which makes curl calls to Tyr API.

Supports Guzzle3 and Guzzle5 since version 1.2.

Composer

Install via composer

{
    "require": {
        "canaltp/tyr-component": "~1.2"
    }
}

Usage

Instanciate TyrService as a plain PHP object:

$tyrUrl = 'http://tyr.dev.canaltp.fr/v0/';
$endPointId = 2;

// Instanciating api
$tyrApi = new CanalTP\TyrComponent\TyrService($tyrUrl, $endPointId); // For Guzzle5
$tyrApi = new CanalTP\TyrComponent\Guzzle3\TyrService($tyrUrl, $endPointId); // For Guzzle3

// Creating request
$user = $tyrApi->createUser('email', 'login');

// Get last Guzzle response instance (usefull to get status code...)
$response = $tyrApi->getLastResponse();
$statusCode = $response->getStatusCode();

See full Tyr class.

Testing

Mock Guzzle client:

$tyrUrl = 'http://tyr.dev.canaltp.fr/v0/';
$endPointId = 2;

$tyrApi = new CanalTP\TyrComponent\TyrService($tyrUrl, $endPointId); // For Guzzle5
$tyrApi = new CanalTP\TyrComponent\Guzzle3\TyrService($tyrUrl, $endPointId); // For Guzzle3

// Creating GuzzleHttp\Client mock...

$tyrApi->setClient($mockedClient);

License

This project is under GPL-3.0 License.