Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mabasic/wakatime-php-api
WakaTime API for PHP
https://github.com/mabasic/wakatime-php-api
php wakatime
Last synced: 5 days ago
JSON representation
WakaTime API for PHP
- Host: GitHub
- URL: https://github.com/mabasic/wakatime-php-api
- Owner: mabasic
- License: mit
- Created: 2014-12-21T16:08:42.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T07:40:32.000Z (7 months ago)
- Last Synced: 2024-11-30T02:28:06.434Z (24 days ago)
- Topics: php, wakatime
- Language: PHP
- Size: 174 KB
- Stars: 51
- Watchers: 9
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# WakaTime PHP API
WakaTime API for PHP
[](https://www.patreon.com/laravelista)
## Overview
This is a PHP package for WakaTime API. It supports resource endpoints from [WakaTime API](https://wakatime.com/developers) with additional helper methods for hours logged.
~~If you are using [Laravel](http://laravel.com/) check out [WakaTime Reports and Laravel](http://laravelista.com/posts/wakatime-reports-and-laravel/)~~.
If you find that some resource endpoints are missing feel free to send me a PR. *(Be sure to include tests for your code)*
## Installation
Type this from command line:
```php
composer require mabasic/wakatime-php-api
```
## Usage
```php
currentUser()
// or
$wakatime->users('username');
```
See: https://wakatime.com/developers/#users for details.
#### Summaries
```php
$wakatime->summaries($startDate, $endDate, $project = null)
```
See: https://wakatime.com/developers/#summaries for details.
#### Stats
```php
$wakatime->stats($range, $project = null)
```
See: https://wakatime.com/developers/#stats for details.
#### Heartbeats
```php
$date = '01/22/2016';
$wakatime->heartbeats($date);
```
See: https://wakatime.com/developers#heartbeats for details.
## Helper methods aka Reports aka Shortcuts
#### getHoursLoggedFor
```php
$wakatime->getHoursLoggedFor($startDate, $endDate, $project = null)
```
Calculates hours logged for a specific period.
_You can optionally specify a project._
> `$startDate` must be lower than `$endDate`
**Example:**
```php
$startDate = '11/21/2014';
$endDate = '12/21/2014';
$hours = $wakaTime->getHoursLoggedFor($startDate, $endDate);
```
#### getHoursLoggedForLast
```php
public function getHoursLoggedForLast($period, $project = null)
```
Calculates hours logged in last xy days, months.
_You can optionally specify a project._
**Example:**
```php
$hours = $wakaTime->getHoursLoggedForLast('7 days');
```
#### getHoursLoggedForToday
```php
public function getHoursLoggedForToday($project = null)
```
Returns hours logged today.
_You can optionally specify a project._
#### getHoursLoggedForYesterday
```php
public function getHoursLoggedForYesterday($project = null)
```
Returns hours logged yesterday.
_You can optionally specify a project._
#### getHoursLoggedForLast7Days
```php
public function getHoursLoggedForLast7Days($project = null)
```
Basic users can only see data for maximum 7 days. Become a Premium user to preserve all data history.
_You can still use any method as long as it is under 7 days._
#### getHoursLoggedForLast30Days
```php
public function getHoursLoggedForLast30Days($project = null)
```
Calculates hours logged for last 30 days in history.
_You can optionally specify a project._
#### getHoursLoggedForThisMonth
```php
public function getHoursLoggedForThisMonth($project = null)
```
Calculates hours logged for this month.
_You can optionally specify a project._
#### getHoursLoggedForLastMonth
```php
public function getHoursLoggedForLastMonth($project = null)
```
Calculates hours logged for last month.
_You can optionally specify a project._
---
## For developers only
Copy `.env.example` file to `.env` and set your api key and project name before running tests with:
```
vendor/bin/phpunit
```
## Laravelista Sponsors & Backers
I would like to extend my thanks to the following sponsors & backers for funding my open-source journey. If you are interested in becoming a sponsor or backer, please visit the Laravelista [Backers page](https://laravelista.hr/backers).
## Contributing
Thank you for considering contributing to WakaTime PHP API! The contribution guide can be found on the [Laravelista website](https://laravelista.hr/contributing).
## Code of Conduct
In order to ensure that the Laravelista community is welcoming to all, please review and abide by the [Code of Conduct](https://laravelista.hr/code-of-conduct).
## License
WakaTime PHP API is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).