README

#php-timecamp-client

一个Timecamp PHP客户端。以关联数组的形式呈现来自Timecamp API的返回数据。

安装

$ composer require osk/timecamp-client

使用

// 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";
}

##身份验证

身份验证非常简单。您必须在实例化Timecamp\Client时传递您的Timecamp API令牌。示例

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

要获取您的API令牌，请访问您的Timecamp账户设置。

客户端方法

用户

users()

返回账户中的所有用户。

示例

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

任务

tasks($options)

返回所有任务。如果您只想获取一个特定的任务，您可以在$options中提供一个'task_id'键。

$options - 关联数组
'task_id' - 要获取的特定任务的ID。

时间条目

####entries($options)

别名，等同于timeEntries($options)

####timeEntries($options)

获取在特定时间范围内开始的时间条目。

$options - 关联数组
'from' - 返回的时间条目的日期范围，例如2015-06-30。
'to' - 返回的时间条目的日期范围，例如2015-06-30。
'task_ids' (可选) - 任务ID的数组。您可以选择不定义此选项，这样将获取所有任务。
'with_subtasks' - (可选) - 如果设置为'1'，则获取为提供的特定任务ID的所有子任务的时间条目。默认值: '1'。
'user_ids' - (可选) - 用户ID的数组。您可以不定义此选项，这样将获取所有用户。

返回一个包含时间条目关联数组的数组。

示例

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

timerRunning()

获取当前正在运行的时间计时器。

示例

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

entriesChanges($options)

获取用户在时间条目中手动进行的更改。这仅在账户设置中启用时才可用。

$options - 关联数组
'from' - 返回的时间条目的日期范围，例如2014-03-19。
'to' - 返回的时间条目的日期范围，例如2014-03-19。
'task_ids' (可选) - 任务ID的数组。您可以选择不定义此选项，这样将获取所有任务。
'user_ids' - (可选) - 用户ID的数组。您可以不定义此选项，这样将获取所有用户。
'limit' - (可选) - 行数的限制（您可以放置任何数字，例如100。

示例

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

##环境变量

HTTP_PROXY

定义在发送使用“http”协议的请求时使用的代理。

HTTPS_PROXY

定义在发送使用“https”协议的请求时使用的代理。

许可证

在MIT许可证下分发。

MIT许可证（MIT）

特此授予任何人免费获得此软件及其相关文档文件（“软件”）副本的许可，以未经限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许向提供该软件的人员提供这样做，但受以下条件的约束

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

osk / timecamp-client

维护者

详情