Download the PHP package pingsrl/laravel-clockify-api without Composer
On this page you can find all versions of the php package pingsrl/laravel-clockify-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-clockify-api
Laravel Clockify API WIP
Laravel repository to fetch reports from the Clockify.me reports API.
Official clockify API: https://clockify.me/developers-api
Installation
-
You can install the package via composer:
composer require pingsrl/laravel-clockify-api
Optional: The service provider will automatically get registered. Or you may manually add the service provider in your config/app.php file:
-
You should publish the config/clockify.php config file with:
php artisan vendor:publish --provider="Ping\LaravelClockifyApi\LaravelClockifyApiServiceProvider"
-
Configure
.env
Add your clockify attributes to your
.env
Usage
Basically
You can get a report by creating a report and calling the get()
function.
Specialized usage
You can further specify the request data by calling the corresponding functions.
The order of the function calls does not matter, except the get()
-function call. This function has to be the last function which gets called. It represents the executer function and executes the request itself.
Example
The following example requests an summary report for user USER_ID_1 and USER_ID_2, from two days ago until today. The results will be sorted ascending.
Attributes to specify a request
Attribute | function | default behaviour or value (when not set) |
possible for reports | |||||
---|---|---|---|---|---|---|---|---|
users |
users(array $userIds) |
all | ALL | |||||
tasks |
tasks(array $taskIds) |
all | ALL | |||||
containsTags |
containsTags(array $tagIds) |
CONTAINS |
ALL | |||||
containsOnlyTags |
containsOnlyTags(array $tagIds) |
CONTAINS |
ALL | |||||
doesNotContainTags |
doesNotContainTags(array $tagIds) |
CONTAINS |
ALL | tasks |
tasks(array $taskIds) |
all | ALL | |
from |
from(Carbon $fromDate) |
start of current year | ALL | |||||
to |
to(Carbon $endDate) |
end of current year | ALL | |||||
sortOrder |
sortOrder(string $sortOrder) |
DESCENDING |
ALL | |||||
filterGroups |
filterGroups(array $filterGroups) |
['USER', 'PROJECT', 'TIMEENTRY'] |
ClockifySummaryReport | |||||
page |
page(int $page) |
1 | ClockifyDetailedReport | |||||
pageSize |
pageSize(int $pageSize) |
50 | ClockifyDetailedReport |
Changelog
Check releases for all notable changes.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-clockify-api with dependencies
laravel/framework Version ^6.0|^7.0|^8.0|^9.0|^10.0
guzzlehttp/guzzle Version ^7.2