PHPackages                             sudiptochoudhury/php-time-doctor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. sudiptochoudhury/php-time-doctor

ActiveLibrary[HTTP & Networking](/categories/http)

sudiptochoudhury/php-time-doctor
================================

PHP Client Library to consume Time Doctor API

0.0.1(5y ago)172MITPHPPHP ^7.1

Since Aug 19Pushed 5y ago1 watchersCompare

[ Source](https://github.com/sudiptochoudhury/php-time-doctor)[ Packagist](https://packagist.org/packages/sudiptochoudhury/php-time-doctor)[ Docs](https://github.com/sudiptochoudhury/php-time-doctor)[ RSS](/packages/sudiptochoudhury-php-time-doctor/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (5)Versions (2)Used By (0)

php-time-doctor
===============

[](#php-time-doctor)

PHP API Client for Time Doctor

> Read all about Time Doctor API from [timedoctor.com](https://webapi.timedoctor.com/doc)

```
use SudiptoChoudhury\TimeDoctor\Api;

$td = new Api([
    'access_token' => ''
]);

$result = $td->getCompanies();

$result = $td->getWorklogs([
    'company_id' => '2348758',
    "start_date" => '2020-08-16',
    'end_date' => '2020-08-31'
]);

```

Installation
------------

[](#installation)

### Requirements

[](#requirements)

- Any flavour of PHP 7.1+ should do

### Install With Composer

[](#install-with-composer)

You can install the library via [Composer](http://getcomposer.org) by adding the following line to the **require** block of your *composer.json* file (replace dev-master with the latest stable version):

```
"sudiptochoudhury/php-time-doctor": "dev-master"

```

or run the following command:

```
composer require sudiptochoudhury/php-time-doctor

```

Setting up
----------

[](#setting-up)

### Authenticate

[](#authenticate)

Below are two OAuth2.0 strategies you can choose when implementing this.

> Before this, you need to register your Time Doctor Application as described [here](https://webapi.timedoctor.com/doc#authentication), setup `redirect_url` and get the `client_id`, `client_secret` from the application.

#### For Web Server based/Desktop/Native applications

[](#for-web-server-baseddesktopnative-applications)

Authorization Code Grant flow: This flow is useful if you have your own server for your app (most common for traditional web apps, as well as native desktop and mobile apps).

**Step 1 - Get Code**

```
use SudiptoChoudhury\TimeDoctor\OAuth;

$tdOAuth = new OAuth();
$tdOAuth->getAuthCode([
    'client_id' => '', // pass your client_id here
    'redirect_uri' => '' // set your redirect_url here
]);
```

This will open authentication portal of your Time Doctor Application and on successful authentication redirect to the given `redirect_url` (an url of your main application) (provided that this url is registered in your Time Doctor Application) with a `code` in it's querystring.

Your site's code should collect and store this code for the next step.

**Step 2 - Generate access\_token**

```
use SudiptoChoudhury\TimeDoctor\OAuth;

$tdOAuth = new OAuth();
$tdOAuth->getToken([
    'client_id' => '',  // pass your client_id here
    'client_secret' => '',  // pass your client_secret here
    'redirect_uri' => '', // pass your redirect_url here
    'code' => '' // set here the code you received in Step 1 stated above
]);
```

You will receive a set of values similar to the one give below:

```
{
    "access_token": "342019_MGQ1MjNiNDEzNzJmMGEzNDgyYWY3M2QA2YTZimjY3ZTFFYzBhNTAxMjEyMjM0MmMwMTFiOWJjOZzZ2NiZDMzMQ",
    "expires_in": 432000,
    "token_type": "bearer",
    "scope": null,
    "refresh_token": "342019_MjQyN2U4ZQAxMzA4ZjRlQTExNGMzQDMzZmQlZjM0QTQwMQU1OTdQNjI0OQNlZDlmNmJiOXZkNWRjOTc3N2YjNg"
}

```

Store the `access_token` and `refresh_token` for future use.

`access_token` will be required in all Time Doctor API calls, while `refresh_token` will be needed to re-generate access token on expiration. `access_token` has a limited life span as shown by `expires_in` (in seconds) property of the received data. The `expires_in` shown in the example data above calculated to 5 days.

The step below shows how to re-generate `access_token` on expiration.

**Retrieve access\_token on expiration using Refresh Token**

```
use SudiptoChoudhury\TimeDoctor\OAuth;

$tdOAuth = new OAuth();
$tdOAuth->refreshToken([
    'client_id' => '',  // pass your client_id here
    'client_secret' => '', // set your client_secret here
    'refresh_token' => '' // set your refresh_token here
]);
```

#### For Web Server-less applications

[](#for-web-server-less-applications)

Implicit Grant flow: Useful when you don't have your own server for your app (suitable for in-browser web apps, such as single-site apps written in JavaScript that cannot make arbitrary GET requests to our public API).

```
use SudiptoChoudhury\TimeDoctor\OAuth;

$tdOAuth = new OAuth();
$tdOAuth->getAuthToken([
    'client_id' => '', // pass your client_id here
    'redirect_uri' => '' // pass your redirect_url here
]);
```

### Use

[](#use)

All you need to do is to pass TimeDoctor `access_token` to the constructor.

```
use SudiptoChoudhury\TimeDoctor\Api;

new Api([
    'access_token' => '',
]);
```

Additionally, you can set a logger via `log` property.

- You can set log to `false` to disable logging.
- You can also pass an array with `file` and `path` properties.

```
use SudiptoChoudhury\TimeDoctor\Api;

new Api([
    'access_token' => '',
    'log' => ['file' => 'TimeDoctor.log', 'path' => '/your/log/path']
]);
```

- You can also pass a `Monolog\Logger` instance.

```
use SudiptoChoudhury\TimeDoctor\Api;

new Api([
    'access_token' => '',
    'log' => ['logger' => $monologInstance]
]);
```

You can use `client` property to forward to `GuzzleHttp\Client` constructor.

```
use SudiptoChoudhury\TimeDoctor\Api;

new Api([
    'access_token' => '',
    'client' => ['timeout' => 5]
]);
```

If you wish to tap into request and response handler stacks use `settings` instead of using `client`'s `handlers` property.

```
'settings' => [
    'responseHandler' => function (ResponseInterface $response) {
        // do something
        return $response;
    },
    'requestHandler' => function (RequestInterface $request) {
        // some action
        return $request;
    },
],
```

How to use
----------

[](#how-to-use)

Next, call the desired method from the table given below. In most methods you may need to pass parameters. The parameters are to be passed as an associative array.

Examples:

```
use SudiptoChoudhury\TimeDoctor\Api;

$td = new Api([
    'access_token' => ''
]);

$result = $td->getCompanies();

$result = $td->getWorklogs([
    'company_id' => '2348758',
    "start_date" => '2020-08-16',
    'end_date' => '2020-08-31'
]);

```

### Available API Methods

[](#available-api-methods)

MethodParametersDescription`getCompanies(array = [])`Returns the user's account(s)`getProjects(array)`offset limit allReturns a collection of a user's projects`getUsers(array)`company\_id emails include\_managerReturns a collection of the company's users`getUser(array)`company\_id, user\_idReturns info about a user`getUserTasks(array)`company\_id user\_id offset limit status latest\_firstReturns a collection of a user's tasks`getUserTask(array)`company\_id user\_id task\_idReturns info about a user's task`getWorklogs(array)`company\_id start\_date end\_date offset limit user\_ids project\_ids task\_ids fields breaks\_only consolidated last\_modifiedReturns a collection of all user's worklogs under the given company Id### Available OAuth API Methods

[](#available-oauth-api-methods)

MethodParametersDescription`getAuthCode(array)``getToken(array)``refreshToken(array)``getAuthToken(array)`

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2092d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/809353?v=4)[Sudipto Choudhury](/maintainers/sudiptochoudhury)[@sudiptochoudhury](https://github.com/sudiptochoudhury)

---

Tags

phpapiclientrestxmltdTime Doctor

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/sudiptochoudhury-php-time-doctor/health.svg)

```
[![Health](https://phpackages.com/badges/sudiptochoudhury-php-time-doctor/health.svg)](https://phpackages.com/packages/sudiptochoudhury-php-time-doctor)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)