README

#php-timecamp-client

A Timecamp PHP client. Presents returned data from the Timecamp API as associative arrays.

Installation

$ composer require osk/timecamp-client

Usage

// Require composer autoloader
require "vendor/autoload.php";

$timecamp = new Timecamp\Client("52253438676fd6dffe7a636f0e");
$entries= $timecamp->timeEntries(array(
  'from'=> '2015-06-01',
  'to'=> '2015-06-30'
));

// var_dump($entries);
foreach($entries as $v) {
  echo "$v[name]\n";
}

##Authentication

Authentication is very simple. You must pass your Timecamp API token when instantiating Timecamp\Client. Example:

$client = new Timecamp\Client("52253438676fd6dffe7a636f0e");

To get your API token go to your Timecamp Account Settings.

Client methods

Users

users()

Return all users from account.

Example

$users = $client->users();
// var_dump($users);
foreach($users as $v) {
  var_dump($v);
}

tasks

tasks($options)

Return all tasks. If you want to get only one specific task you can provide a 'task_id' key in $options.

$options - Associative array
'task_id' - Id of a specific task to get.

Time entries

####entries($options)

Alias for timeEntries($options)

####timeEntries($options)

Get time entries started in a specific time range.

$options - Associative array
'from' - date range of the time entries returned like 2015-06-30.
'to' - date range of the time entries returned like 2015-06-30.
'task_ids' (optional) - array of tasks ids you can leave this option undefined, so it will get all tasks.
'with_subtasks' - (optional) - If set to '1' , get entries for all subtasks for provided one specific task_ids. Default: '1'.
'user_ids' - (optional) - Array of user ids. you can leave this option undefined, so it willl get all users

Returns an array of time entries associative arrays.

Example

$entries = $client->timeEntries(array(
  'from'=> '2015-06-01',
  'to'=> '2015-06-30'
));
// var_dump($entries);
foreach($entries as $v) {
  var_dump($v);
}

timerRunning()

Get currently running timers.

Example

$timers = $client->timeRunning();
// var_dump($timers);
foreach($timers as $v) {
  var_dump($v);
}

entriesChanges($options)

Get manual changes in time entries made by users. This is only available only when it is enabled in Account Settings.

$options - Associative array
'from' - date range of the time entries returned like 2014-03-19.
'to' - date range of the time entries returned like 2014-03-19.
'task_ids' (optional) - array of tasks ids you can leave this option undefined, so it will get all tasks.
'user_ids' - (optional) - Array of user ids. you can leave this option undefined, so it willl get all users
'limit' - (optional) - Limit for the number of rows (you can put any number like 100.

Examples

$changes= $timecamp->entriesChanges(array(
  'from'=> '2015-06-01',
  'to'=> '2015-06-30'
));
// var_dump($changes);
foreach($changes as $v) {
  var_dump($v);
}

##Environment variables

HTTP_PROXY

Defines the proxy to use when sending requests using the "http" protocol.

HTTPS_PROXY

Defines the proxy to use when sending requests using the "https" protocol.

License

Distributed under the MIT License.

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

https://github.com/educoder/pest https://github.com/guzzle/guzzle https://github.com/Respect/Rest/

osk / timecamp-client

Maintainers

Details