README

PHP 的 WakaTime API

概览

这是一个用于 WakaTime API 的 PHP 包。它支持从 WakaTime API 获取资源端点，并为记录的小时数提供了额外的辅助方法。

如果您使用 Laravel，请查看 WakaTime Reports and Laravel.

如果您发现某些资源端点缺失，请随时向我发送 PR。 (请确保包括您的代码的测试)

安装

在命令行中输入以下内容

composer require mabasic/wakatime-php-api

用法

<?php

use GuzzleHttp\Client as Guzzle;
use Mabasic\WakaTime\WakaTime;

$wakatime = new WakaTime(new Guzzle, $your_api_key_for_wakatime);

您可以从您的 设置页面 获取 API 密钥。

资源端点

用户

$wakatime->currentUser()

// or

$wakatime->users('username');

详细信息请参见：https://wakatime.com/developers/#users

摘要

$wakatime->summaries($startDate, $endDate, $project = null)

详细信息请参见：https://wakatime.com/developers/#summaries

统计信息

$wakatime->stats($range, $project = null)

详细信息请参见：https://wakatime.com/developers/#stats

心跳

$date = '01/22/2016';

$wakatime->heartbeats($date);

详细信息请参见：https://wakatime.com/developers#heartbeats

辅助方法（即报告或快捷方式）

getHoursLoggedFor

$wakatime->getHoursLoggedFor($startDate, $endDate, $project = null)

计算特定时间段内记录的小时数。您可以选择指定一个项目。

$startDate 必须小于 $endDate

示例

$startDate = '11/21/2014';
$endDate = '12/21/2014';

$hours = $wakaTime->getHoursLoggedFor($startDate, $endDate);

getHoursLoggedForLast

public function getHoursLoggedForLast($period, $project = null)

计算最后 xy 天、月内记录的小时数。您可以选择指定一个项目。

示例

$hours = $wakaTime->getHoursLoggedForLast('7 days');

getHoursLoggedForToday

public function getHoursLoggedForToday($project = null)

返回今天记录的小时数。您可以选择指定一个项目。

getHoursLoggedForYesterday

public function getHoursLoggedForYesterday($project = null)

返回昨天记录的小时数。您可以选择指定一个项目。

getHoursLoggedForLast7Days

public function getHoursLoggedForLast7Days($project = null)

基本用户只能查看最多 7 天的数据。成为高级用户以保留所有数据历史。 只要在 7 天内，您仍然可以使用任何方法。

getHoursLoggedForLast30Days

public function getHoursLoggedForLast30Days($project = null)

计算历史中最后 30 天记录的小时数。您可以选择指定一个项目。

getHoursLoggedForThisMonth

public function getHoursLoggedForThisMonth($project = null)

计算本月中记录的小时数。您可以选择指定一个项目。

getHoursLoggedForLastMonth

public function getHoursLoggedForLastMonth($project = null)

计算上月中记录的小时数。您可以选择指定一个项目。

仅限开发者

将 .env.example 文件复制到 .env，在运行测试前设置您的 API 密钥和项目名称

vendor/bin/phpunit

Laravelista 赞助商和资助者

我想向以下赞助商和资助者表示感谢，他们为我资助了开源之旅。如果您有兴趣成为赞助商或资助者，请访问 Laravelista 的 资助者页面。

贡献

感谢您考虑为 WakaTime PHP API 做出贡献！贡献指南可在 Laravelista 网站上找到。

行为准则

为了确保Laravelista社区对所有成员都友好，请阅读并遵守行为准则。

许可证

WakaTime PHP API是开源软件，采用MIT许可证。