target-process-php-client

PHP client for Target Process Management Software

Instalation using composer:

    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/toecto/targetprocess-php-client"
        }
    ],

    "require": {
        "toecto/targetprocess-php-client": "dev-master",
    },

Using

Collections are implemented as dinamic methods. For example $tp_client->Tasks() or $tp_client->Users() and etc.

Use reference to get collection names

Create client

$cl = new \ToEcto\TargetprocessPHPClient\Client('http://domain.com/api/v1/', 'user', 'password');

Get list of objects, it is limited you will have to request more with additional parameters if list is long

$array = $cl->Users()->get();
$array = $cl->Users()->get('', array('take' => 25, 'skip' => 25));

Will make few requests for at gete full list Be carefull with long lists!

$array = $cl->Users()->getAll();

Get one user

$array = $cl->Users()->get(18);

Add object

$cl->Users()->add($array);

// Example: add a new bug
$params = array(
	'Project' => array('Id' => $project),
	'Name' => $title,
	'Description' => $description,
);
$bug = $cl->Bugs()->add($params)->getResponse();

Update object

$cl->Users()->set($id, $array);

Note: add() and set() return client object itself Use getResponse() in order to get last responce object:

$cl->getResponse();

Handle errors for default transport

try {
    $tp_entity = $tp_client->Assignables()->get($entityID);
} catch (\GuzzleHttp\Exception\ClientException $e) {
    if ($e->getResponse()->getStatusCode() == 404) {
        error_log('Entity tp-'.$entityID.' does not exist');
        return;
    }
}

Sub collections

Get All tasks for user with id = 18

$array = $cl->Users()->open(18)->Assignables()->getAll();

Dynamic properties shortcut

$array = $cl->Users()->open(18)->Assignables;

is equal to

$array = $cl->Users()->open(18)->Assignables()->get();

Overriding Guzzle client config

If for any reason you need to override the Guzzle client config, you can do it like this:

$connection = new \ToEcto\TargetprocessPHPClient\Transport($url, $params['username'], $params['password'], array(
    'defaults'=> array(
        'headers' => array(
            'Accept' => 'application/json',
        ),
        'config' => array(
            'curl' => array(
                CURLOPT_HTTPAUTH => CURLAUTH_NTLM,
                CURLOPT_USERPWD  => $user . ':' . $pass
            )
        )
    )
));
$targetprocessClient = new \ToEcto\TargetprocessPHPClient\Client($connection);