PHP Jira Rest Client

https://github.com/lesstif/php-jira-rest-client
Admin
A PHP client library for interacting with Jira's REST API, primarily for on-premise installations,...
Tokens:238,547
Snippets:1,481
Trust Score:9.5
License:Apache-2.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### get method usage example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/03-issue-service.md

Example of retrieving an issue with specific fields and printing the summary.

```php
$issue = $issueService->get('PROJ-123', ['fields' => 'summary,status']);
echo $issue->fields->summary;
```

--------------------------------

### Run Composer install

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Completes installation by running Composer's install command.

```sh
php composer.phar install
```

--------------------------------

### Install Composer

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Downloads and installs PHP Composer using curl.

```sh
curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### Get board info using BoardService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches a single board's details by its ID using the BoardService. The board ID is hardcoded as 1 in the example.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Board\BoardService;

try {
  $board_service = new BoardService();
  $board_id = 1;
  $board = $board_service->getBoard($board_id);
  
  var_dump($board);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Find Users with UserService::findUsers

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Returns a list of users matching the search string and/or property. The example uses username '.' to get all users, with startAt, maxResults, and includeInactive parameters.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\User\UserService;

try {
    $us = new UserService();

    $paramArray = [
        'username' => '.', // get all users. 
        'startAt' => 0,
        'maxResults' => 1000,
        'includeInactive' => true,
        //'property' => '*',
    ];

    // get the user info.
    $users = $us->findUsers($paramArray);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Get board list using BoardService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves the list of boards using the BoardService and dumps the result. The example uses a hardcoded board ID of 1 for the getBoard call.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Board\BoardService;

try {
  $board_service = new BoardService();
  $board = $board_service->getBoardList();
  
  var_dump($board);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Get Users from Group with GroupService::getMembers

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Returns a paginated list of users who are members of the specified group and its subgroups. The example sets groupname, includeInactiveUsers (default false), startAt, and maxResults, then prints each user.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\Group\GroupService;

try {
   $queryParam = [
        'groupname' => 'Test group for REST API',
        'includeInactiveUsers' => true, // default false
        'startAt' => 0,
        'maxResults' => 50,
    ];

    $gs = new GroupService();

    $ret = $gs->getMembers($queryParam);

    // print all users in the group
    foreach($ret->values as $user) {
        print_r($user);
    }
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Install php-jira-rest-client via Composer

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Runs the Composer command to install the latest version of the php-jira-rest-client package.

```sh
php composer.phar require lesstif/php-jira-rest-client
```

--------------------------------

### Get Project Info with ProjectService::get

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches a project by key 'TEST'.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\JiraException;

try {
    $proj = new ProjectService();

    $p = $proj->get('TEST');
	
    var_dump($p);			
} catch (JiraRestApi\JiraException $e) {
	print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### Add Worklog Example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/03-issue-service.md

Creates a Worklog object with a comment, start time, and time spent, then adds it to an issue.

```php
use JiraRestApi\Issue\Worklog;

$wl = new Worklog();
$wl->setComment('worked on it')
   ->setStarted(new \DateTime('2024-01-10 09:00:00'))
   ->setTimeSpent('3h');
$issueService->addWorklog('PROJ-123', $wl);
```

--------------------------------

### Create Sub Task Example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Full example of creating a sub-task using IssueService. Sets project, summary, assignee, priority, description, versions, issue type as 'Sub-task', and parent key. On success, returns a link to the created sub-task.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Issue\IssueService;
use JiraRestApi\Issue\IssueField;
use JiraRestApi\JiraException;

try {
    $issueField = new IssueField();

    $issueField->setProjectKey('TEST')
                ->setSummary('something\'s wrong')
                ->setAssigneeNameAsString('lesstif')
                ->setPriorityNameAsString('Critical')
                ->setDescription('Full description for issue')
                ->addVersion('1.0.1')
                ->addVersion('1.0.3')
                ->setIssueTypeAsString('Sub-task')  //issue type must be Sub-task
                ->setParentKeyOrId('TEST-143')  //Issue Key
    ;

    $issueService = new IssueService();

    $ret = $issueService->create($issueField);

    //If success, Returns a link to the created sub task.
    var_dump($ret);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### Get all custom fields example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/09-misc-services.md

Shows how to instantiate FieldService and iterate over all custom fields, printing each field's ID and name.

```php
use JiraRestApi\Field\FieldService;
use JiraRestApi\Field\Field;

$fieldService = new FieldService($config);
foreach ($fieldService->getAllFields(Field::CUSTOM) as $field) {
    echo $field->id . ' ' . $field->name . PHP_EOL;
}
```

--------------------------------

### search method usage example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/03-issue-service.md

Example of searching issues with JQL, iterating results, and handling pagination with nextPageToken.

```php
$result = $issueService->search('project = PROJ order by created DESC', '', 100);
foreach ($result->getIssues() as $issue) {
    echo $issue->key . ': ' . $issue->fields->summary . PHP_EOL;
}
if ($result->getNextPageToken()) {
    $next = $issueService->search($jql, $result->getNextPageToken(), 100);
}
```

--------------------------------

### Get board epics using BoardService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches epics for a specific board with a maxResults parameter. The example uses a hardcoded board ID of 1 and iterates over the returned epics.

```php
<?php
require 'vendor/autoload.php';

try {
  $board_service = new JiraRestApi\Board\BoardService();
  $board_id = 1;
  $epics = $board_service->getBoardEpics($board_id, [
    'maxResults' => 500,
  ]);
  
  foreach ($epics as $epic) {
    var_dump($epic);
  }
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### create usage example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/03-issue-service.md

Example of creating an issue with IssueField, setting project key, summary, issue type, and priority. Catches JiraException and prints message and response.

```php
use JiraRestApi\Issue\IssueService;
use JiraRestApi\Issue\IssueField;

$field = new IssueField();
$field->setProjectKey('PROJ')
      ->setSummary('Bug found')
      ->setIssueTypeAsString('Bug')
      ->setPriorityNameAsString('High');

try {
    $issue = $issueService->create($field);
    echo 'Created ' . $issue->key;
} catch (\JiraRestApi\JiraException $e) {
    echo $e->getMessage() . PHP_EOL . $e->getResponse();
}
```

--------------------------------

### Get Project Components for All Projects

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches all projects and then retrieves components for each project using getProjectComponents.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\JiraException;

try {
    $proj = new ProjectService();

    $prjs = $proj->getAllProjects();

    // Extract and show Project Components for every Jira Project
    foreach ($prjs as $p) {
        var_export($proj->getProjectComponents($p->id));
    }
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### Get All Projects with ProjectService::getAllProjects

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves all projects and prints key, id, name, and project category name for each.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\JiraException;

try {
    $proj = new ProjectService();

    $prjs = $proj->getAllProjects();

    foreach ($prjs as $p) {
        echo sprintf('Project Key:%s, Id:%s, Name:%s, projectCategory: %s\n',
            $p->key, $p->id, $p->name, $p->projectCategory['name']
        );			
    }			
} catch (JiraRestApi\JiraException $e) {
	print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### Add dependency to composer.json

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Alternative installation method: add the package requirement to composer.json.

```json
{
    "require": {
        "lesstif/php-jira-rest-client": "^5.0"
    }
}
```

--------------------------------

### ServiceDeskClient usage example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/10-service-desk.md

Shows how to instantiate ServiceDeskClient with an ArrayConfiguration and call createUrl() to build a ServiceDesk API URL. The example uses token-based authentication with a personal access token.

```php
use JiraRestApi\ServiceDesk\ServiceDeskClient;

$client = new ServiceDeskClient(new \JiraRestApi\Configuration\ArrayConfiguration([
    'jiraHost'          => 'https://your-jira.atlassian.net',
    'useTokenBasedAuth' => true,
    'personalAccessToken' => 'token',
]));
echo $client->createUrl('%s/%s', ['/request', 'IT-123']);
```

--------------------------------

### Get Attachment and Save to Directory using AttachmentService::get

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Gets attachment information and saves the attachment into the specified output directory. Uses AttachmentService::get with $outDir and $overwrite parameters.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Attachment\AttachmentService;
use JiraRestApi\JiraException;

try {
    $attachmentId = 12345;
    $outDir = 'attachment_dir';
    
    $atts = new AttachmentService();
    $att = $atts->get($attachmentId, $outDir, $overwrite = true);

    var_dump($att);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Get Project Types with getProjectTypes and getProjectType

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves all project types and then a specific type by key 'software'.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\JiraException;

try {
    $proj = new ProjectService();

    // get all project type
    $prjtyps = $proj->getProjectTypes();

    foreach ($prjtyps as $pt) {
        var_dump($pt);
    }

    // get specific project type.
    $pt = $proj->getProjectType('software');
    var_dump($pt);

} catch (JiraRestApi\JiraException $e) {
	print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### Get All Priorities using PriorityService::getAll

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves all Jira priorities. Uses PriorityService and dumps the result with var_dump.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Priority\PriorityService;
use JiraRestApi\JiraException;

try {
    $ps = new PriorityService();

    $p = $ps->getAll();
	
    var_dump($p);
} catch (JiraRestApi\JiraException $e) {
	print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Delete User with UserService::deleteUser

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Removes a user. The example passes a username parameter.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\User\UserService;

try {
    $us = new UserService();

    $paramArray = ['username' => 'user@example.com'];

    $users = $us->deleteUser($paramArray);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### get

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/06-project-service.md

Retrieves a single project by its ID or key.

```APIDOC
## [GET] /project/{key}

### Description
Retrieves a single project by its ID or key.

### Method
GET

### Endpoint
/project/{key}

### Parameters
#### Path Parameters
- **projectIdOrKey** (int|string) - Required - The project ID or key.

### Response
#### Success Response (200)
- **Project** - The project object.

#### Response Example
```json
{
  "id": "10000",
  "key": "PROJ",
  "name": "Project Name"
}
```
```

--------------------------------

### Copy .env.example to .env

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Copies the .env.example file to .env on your project root for dotenv configuration.

```sh
cp .env.example .env
```

--------------------------------

### Get epic info using EpicService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches a single epic's details by its ID using the EpicService. The epic ID is hardcoded as 1 in the example.

```php
<?php
require 'vendor/autoload.php';

try {
  $epic_service = new JiraRestApi\Epic\EpicService();
  $epic_id = 1;
  $epic = $epic_service->getEpic($epic_id);
  
  var_dump($epic);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Create Group with GroupService::createGroup

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Creates a new group. The example sets the group name and calls createGroup, then dumps the result.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\Group\GroupService;
use JiraRestApi\Group\Group;

try {
    $g = new Group();

    $g->name = 'Test group for REST API';

    $gs = new GroupService();
    $ret = $gs->createGroup($g);

    var_dump($ret);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### GET {api}/project/{key}/versions

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Retrieves all versions of a project.

```APIDOC
## [GET] {api}/project/{key}/versions

### Description
Retrieves all versions of a project.

### Method
GET

### Endpoint
{api}/project/{key}/versions

### Parameters
#### Path Parameters
- **key** (string) - Required - Project key.

### Response
#### Success Response (200)
- **versions** (array) - List of version objects.

#### Response Example
{
  "versions": []
}
```

--------------------------------

### Example .env configuration

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Environment variables for JIRA host, credentials, token-based auth, proxy settings, and optional cookie auth. Note: Basic auth with password is deprecated; use API token instead.

```sh
JIRA_HOST='https://your-jira.host.com'
JIRA_USER='jira-username'
JIRA_PASS='jira-password-OR-api-token'
# if TOKEN_BASED_AUTH set to true, ignore JIRA_USER and JIRA_PASS.
TOKEN_BASED_AUTH=true
PERSONAL_ACCESS_TOKEN='your-access-token-here'
# to enable session cookie authorization
# COOKIE_AUTH_ENABLED=true
# COOKIE_FILE=storage/jira-cookie.txt
# if you are behind a proxy, add proxy settings
PROXY_SERVER='your-proxy-server'
PROXY_PORT='proxy-port'
PROXY_USER='proxy-username'
PROXY_PASSWORD='proxy-password'
```

--------------------------------

### Create component using ComponentService::create

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Creates a new Jira component with a name, description, and project key. Throws JiraException on error.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Component\ComponentService;
use JiraRestApi\Issue\Version;
use JiraRestApi\Project\Component;
use JiraRestApi\JiraException;

try {
    $componentService = new ComponentService();
    
    $component = new Component();
    $component->setName('my component')
              ->setDescription('Generated by script')
              ->setProjectKey('TEST');

    $res = $componentService->create($component);

    var_dump($res);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Get comment by ID with getComment

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves a single comment by its ID using IssueService::getComment. Parameters include startAt, maxResults, and expand 'renderedBody'. The comment ID is set to 13805 in the example.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Issue\IssueService;
use JiraRestApi\JiraException;

$issueKey = 'TEST-879';

try {
    $issueService = new IssueService();
    
    $param = [
         'startAt' => 0, 
         'maxResults' => 3,
         'expand' => 'renderedBody',
    ];
    $commentId = 13805;

    $comments = $issueService->getComment($issueKey, $commentId, $param);

    var_dump($comments);

} catch (JiraRestApi\JiraException $e) {
    $this->assertTrue(false, 'get Comment Failed : '.$e->getMessage());
}

```

--------------------------------

### Get all boards with pagination using BoardService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches all boards by paginating through results using startAt and maxResults parameters. The loop continues until startAt reaches the total count from the response.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Board\BoardService;

try {
  $results = [];
  $startAt = 0;
  $maxResults = 50; // maximum allowed for board queries

  do {
      $response = $this->boardService->getBoards([
        'startAt' => $startAt,
        'maxResults' => $maxResults
      ]);

      $results = [...$results, ...$response->getBoards()];

      $startAt += $maxResults;

  } while($startAt < $response->total);
  
  var_dump($results);
  
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Get All Field List with FieldService::getAllFields

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves all fields, optionally filtered to custom fields only by passing Field::CUSTOM. The example uses Field::CUSTOM to return only custom fields. Catches JiraRestApi\JiraException.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Field\Field;
use JiraRestApi\Field\FieldService;
use JiraRestApi\JiraException;

try {
    $fieldService = new FieldService();

    // return custom field only. 
    $ret = $fieldService->getAllFields(Field::CUSTOM); 
    	
    var_dump($ret);
} catch (JiraRestApi\JiraException $e) {
    $this->assertTrue(false, 'testSearch Failed : '.$e->getMessage());
}

```

--------------------------------

### Get board issues using BoardService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves issues for a specific board with optional parameters like maxResults and a JQL filter. The example uses a hardcoded board ID of 1 and filters out closed issues.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Board\BoardService;

try {
  $board_service = new BoardService();
  $board_id = 1;
  $issues = $board_service->getBoardIssues($board_id, [
    'maxResults' => 500,
    'jql' => urlencode('status != Closed'),
  ]);
  
  foreach ($issues as $issue) {
    var_dump($issue);
  }
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Create Version using VersionService::create

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Creates a new Jira version for a project. Requires a project key and sets version details like name, description, release dates, and project ID.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Issue\Version;
use JiraRestApi\Project\ProjectService;
use JiraRestApi\Version\VersionService;
use JiraRestApi\JiraException;

try {
    $projectService = new ProjectService();
    $project = $projectService->get('TEST');

    $versionService = new VersionService();

    $version = new Version();

    $version->setName('1.0.0')
            ->setDescription('Generated by script')
            ->setReleased(true)
            ->setStartDateAsDateTime(new \DateTime())
            ->setReleaseDateAsDateTime((new \DateTime())->add(date_interval_create_from_date_string('1 months 3 days')))
            ->setProjectId($project->id)
            ;

    $res = $versionService->create($version);

    var_dump($res);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}


```

--------------------------------

### Create Custom Field with FieldService::create

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Creates a custom field by setting name, description, type, and searcher key. The example uses a group picker type. Catches JiraRestApi\JiraException. For a list of custom field types, see the 'Get All Field List' section.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Field\Field;
use JiraRestApi\Field\FieldService;
use JiraRestApi\JiraException;

try {
    $field = new Field();
    
    $field->setName('New custom field')
            ->setDescription('Custom field for picking groups')
            ->setType('com.atlassian.jira.plugin.system.customfieldtypes:grouppicker')
            ->setSearcherKey('com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher');

    $fieldService = new FieldService();

    $ret = $fieldService->create($field);
    
    var_dump($ret);
} catch (JiraRestApi\JiraException $e) {
    $this->assertTrue(false, 'Field Create Failed : '.$e->getMessage());
}

```

--------------------------------

### Get Epic Issues with EpicService

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves issues belonging to a specific epic using the JiraRestApi\Epic\EpicService class. The example sets a maximum of 500 results and filters out closed issues via a JQL query. Requires the JIRA REST API client library and a valid epic ID.

```php
<?php
require 'vendor/autoload.php';

try {
  $epic_service = new JiraRestApi\Epic\EpicService();
  $epic_id = 1;
  $issues = $epic_service->getEpicIssues($epic_id, [
    'maxResults' => 500,
    'jql' => urlencode('status != Closed'),
  ]);
  
  foreach ($issues as $issue) {
    var_dump($issue);
  }
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Find Assignable Users with UserService::findAssignableUsers

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Returns a list of users that match the search string. The example uses project 'TEST' and sets startAt and maxResults (max 1000).

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\User\UserService;

try {
    $us = new UserService();

    $paramArray = [
        //'username' => null,
        'project' => 'TEST',
        //'issueKey' => 'TEST-1',
        'startAt' => 0,
        'maxResults' => 50, //max 1000
        //'actionDescriptorId' => 1,
    ];

    $users = $us->findAssignableUsers($paramArray);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Get Issue Info with IssueService::get

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Fetches a full issue representation by key, with optional fields and expand parameters. The example requests specific fields (summary, comment) and expansions. Access custom fields via $issue->fields->customFields or direct property like $issue->fields->customfield_10300.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Issue\IssueService;
use JiraRestApi\JiraException;

try {
    $issueService = new IssueService();
	
    $queryParam = [
        'fields' => [  // default: '*all'
            'summary',
            'comment',
        ],
        'expand' => [
            'renderedFields',
            'names',
            'schema',
            'transitions',
            'operations',
            'editmeta',
            'changelog',
        ]
    ];
            
    $issue = $issueService->get('TEST-867', $queryParam);
	
    var_dump($issue->fields);	
} catch (JiraRestApi\JiraException $e) {
	print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Update User with UserService::update

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Updates a user. The example passes a username parameter and a user array with name, password, emailAddress, and displayName.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\User\UserService;

try {
    $us = new UserService();

    $paramArray = ['username' => 'user@example.com'];

    // create new user
    $user = [
            'name'=>'charli',
            'password' => 'abracada',
            'emailAddress' => 'charli@atlassian.com',
            'displayName' => 'Charli of Atlassian',
        ];

    $updatedUser = $us->update($paramArray, $user)

    var_dump($updatedUser);

} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Install phpdotenv dependency

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Installs the vlucas/phpdotenv package required for dotenv-based configuration.

```sh
composer require vlucas/phpdotenv
```

--------------------------------

### get method signature

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/03-issue-service.md

Signature for the get method that retrieves an issue by ID or key.

```php
public function get($issueIdOrKey, $paramArray = [], $issueObject = null): Issue
```

--------------------------------

### GreenHopperTrait and ServiceDeskTrait setupAPIUri methods

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/07-agile.md

Defines two traits that override the API URI setup. GreenHopperTrait sets the URI to '/rest/greenhopper/1.0', while ServiceDeskTrait sets it to '/rest/servicedeskapi' with an optional version suffix.

```php
trait GreenHopperTrait
{
    private function setupAPIUri($version = '1.0')
    {
        $this->setAPIUri('/rest/greenhopper/'.$version);
    }
}
```

```php
trait ServiceDeskTrait
{
    private function setupAPIUri($version = '')
    {
        $uri = '/rest/servicedeskapi';
        $uri .= ($version != '') ? '/'.$version : '';
        $this->setAPIUri($uri);
    }
}
```

--------------------------------

### get

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/10-service-desk.md

Retrieves an organization by its ID using a GET request to the /organization/{id} endpoint.

```APIDOC
## [GET] /organization/{id}

### Description
Retrieves an organization by its ID.

### Method
GET

### Endpoint
/organization/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the organization.

### Response
#### Success Response (200)
- **Organisation** - The organization object.

#### Response Example
{
  "id": "string",
  "name": "string"
}
```

--------------------------------

### Usage example: chaining JqlQuery methods

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/05-jql.md

Shows how to instantiate JqlQuery, chain setProject, setStatus, and setAssignee, then output the query and pass it to IssueService::search(). The resulting query string is shown in the comment.

```php
use JiraRestApi\Issue\JqlQuery;

$query = new JqlQuery();
$query->setProject('PROJ')
      ->setStatus('Open')
      ->setAssignee(JqlFunction::currentUser());
echo $query->getQuery();
// "project" = "PROJ" and "status" = "Open" and "assignee" = currentUser()

$result = $issueService->search($query->getQuery(), '', 100);
```

--------------------------------

### get

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/08-users-groups-auth.md

Retrieves a user by username, key, or accountId. Sends a GET request to the /user endpoint with query parameters.

```APIDOC
## [GET] /user?{params}

### Description
Retrieves a user by username, key, or accountId.

### Method
GET

### Endpoint
/user?{params}

### Parameters
#### Query Parameters
- **username** (string) - Optional - The username of the user.
- **key** (string) - Optional - The key of the user.
- **accountId** (string) - Optional - The account ID of the user.

### Response
#### Success Response (200)
- **User** (User) - The user object.

#### Response Example
```json
{
  "name": "john.doe",
  "emailAddress": "john.doe@example.com"
}
```
```

--------------------------------

### ClassSerialize usage example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/11-support-classes.md

Example of using ClassSerialize trait with TimeTracking: set original and remaining estimates, then convert to array and pretty-printed JSON.

```php
use JiraRestApi\Issue\TimeTracking;

$tt = new TimeTracking();
$tt->setOriginalEstimate('3d');
$tt->setRemainingEstimate('2d');
$array = $tt->toArray();           // ['originalEstimate' => '3d', 'remainingEstimate' => '2d']
$json = $tt->toString();           // pretty-printed JSON
```

--------------------------------

### Delete Project with ProjectService::deleteProject

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Deletes a project by key 'EX'.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\JiraException;

try {
    $proj = new ProjectService();

    $pj = $proj->deleteProject('EX');
   
    var_dump($pj);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### Create Project

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Creates a new Jira project using the ProjectService. Requires a Project object with key, name, project type key, and template key. Outputs the new project's self URL and ID.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\Project\Project;
use JiraRestApi\JiraException;

try {
    $p = new Project();

    $p->setKey('EX')
        ->setName('Example')
        ->setProjectTypeKey('business')
        ->setProjectTemplateKey('com.atlassian.jira-core-project-templates:jira-core-project-management')
        ->setDescription('Example Project description')
        ->setLeadName('lesstif')
        ->setUrl('http://example.com')
        ->setAssigneeType('PROJECT_LEAD')
        ->setAvatarId(10130)
        ->setIssueSecurityScheme(10000)
        ->setPermissionScheme(10100)
        ->setNotificationScheme(10100)
        ->setCategoryId(10100)
    ;

    $proj = new ProjectService();

    $pj = $proj->createProject($p);
   
    // 'http://example.com/rest/api/2/project/10042'
    var_dump($pj->self);
    // 10042 
    var_dump($pj->id);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### Basic GET request with exec()

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/01-jira-client.md

Performs a GET request to the Jira REST API using exec(). The response is JSON-decoded and the issue key is echoed.

```php
$response = $client->exec('issue/PROJ-123');        // GET {host}/rest/api/2/issue/PROJ-123
$issue = json_decode($response);
echo $issue->key;
```

--------------------------------

### toHttpQueryParameter usage example

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/01-jira-client.md

Shows how to call toHttpQueryParameter with a JQL query and fields array, producing a URL-encoded query string. The example output is '?jql=project%20%3D%20PROJ&fields=summary,status'.

```php
$query = $client->toHttpQueryParameter(['jql' => 'project = PROJ', 'fields' => ['summary', 'status']]);
// => "?jql=project%20%3D%20PROJ&fields=summary,status"
```

--------------------------------

### ProjectService usage: list and create projects

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/06-project-service.md

Shows how to instantiate ProjectService, list all projects, and create a new project with required fields.

```php
use JiraRestApi\Project\ProjectService;
use JiraRestApi\Project\Project;

$projectService = new ProjectService($config);

// list projects
foreach ($projectService->getAllProjects() as $project) {
    echo $project->key . ' - ' . $project->name . PHP_EOL;
}

// create a project
$project = new Project();
$project->setKey('NEW')
        ->setName('New Project')
        ->setProjectTypeKey('software')
        ->setLeadAccountId('5b10a2844c20165700ede21g');
$created = $projectService->createProject($project);
```

--------------------------------

### Get and set issue time tracking using IssueService::getTimeTracking and timeTracking

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Retrieves the current time tracking info for an issue and then updates it with new estimates. Uses TimeTracking object with original and remaining estimates. The methods internally use get issue and edit issue APIs.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Issue\IssueService;
use JiraRestApi\Issue\TimeTracking;
use JiraRestApi\JiraException;

$issueKey = 'TEST-961';

try {
    $issueService = new IssueService();
    
    // get issue's time tracking info
    $ret = $issueService->getTimeTracking($this->issueKey);
    var_dump($ret);
    
    $timeTracking = new TimeTracking;

    $timeTracking->setOriginalEstimate('3w 4d 6h');
    $timeTracking->setRemainingEstimate('1w 2d 3h');
    
    // add time tracking
    $ret = $issueService->timeTracking($this->issueKey, $timeTracking);
    var_dump($ret);
} catch (JiraRestApi\JiraException $e) {
    $this->assertTrue(false, 'testSearch Failed : '.$e->getMessage());
}


```

--------------------------------

### IssueService with .env based configuration

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/configuration.md

Default configuration when no argument is passed to IssueService. Loads ./.env (or ../.env fallback). Requires JIRA_HOST and TOKEN_BASED_AUTH environment variables; missing them throws a JiraException.

```php
// .env based (default when no argument is passed)
use JiraRestApi\Issue\IssueService;

$issueService = new IssueService();          // loads ./.env (or ../.env fallback)
```

--------------------------------

### GET {api}/status/

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Retrieves all statuses.

```APIDOC
## [GET] {api}/status/

### Description
Retrieves all statuses.

### Method
GET

### Endpoint
{api}/status/

### Response
#### Success Response (200)
- **statuses** (array) - List of status objects.

#### Response Example
{
  "statuses": []
}
```

--------------------------------

### POST {sd}/customer

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Creates a customer.

```APIDOC
## POST {sd}/customer

### Description
Creates a customer.

### Method
POST

### Endpoint
{sd}/customer

### Request Body
- Customer details (object) - Required - The customer data.

### Response
#### Success Response (201)
- Returns the created customer.

```

--------------------------------

### GET {api}/field

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Retrieves all fields.

```APIDOC
## [GET] {api}/field

### Description
Retrieves all fields.

### Method
GET

### Endpoint
{api}/field

### Response
#### Success Response (200)
- **fields** (array) - List of field objects.

#### Response Example
{
  "fields": []
}
```

--------------------------------

### GET {api}/users

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Retrieves all users.

```APIDOC
## [GET] {api}/users

### Description
Retrieves all users.

### Method
GET

### Endpoint
{api}/users

### Response
#### Success Response (200)
- **users** (array) - List of user objects.

#### Response Example
{
  "users": []
}
```

--------------------------------

### Find Users by Query with UserService::findUsersByQuery

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Returns a list of users that match the search string. The example uses query 'is watcher of TEST' and dumps the result.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\JiraException;
use JiraRestApi\User\UserService;

try {
    $us = new UserService();

    $paramArray = [
      'query' => 'is watcher of TEST',
    ];

    $users = $us->findUsersByQuery($paramArray);
    var_dump($users);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}

```

--------------------------------

### GET {api}/user/search

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Searches for users.

```APIDOC
## [GET] {api}/user/search

### Description
Searches for users.

### Method
GET

### Endpoint
{api}/user/search

### Parameters
#### Query Parameters
- **username** (string) - Required - Search query.
- **startAt** (integer) - Optional - Starting index.
- **maxResults** (integer) - Optional - Maximum results.

### Response
#### Success Response (200)
- **users** (array) - List of user objects.

#### Response Example
{
  "users": []
}
```

--------------------------------

### VersionService::create

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Creates a new version for a project. This method is part of the VersionService class and requires a Version object with project ID and other details.

```APIDOC
## VersionService::create

### Description
Creates a new version for a project.

### Method
create

### Parameters
- **$version** (Version) - Required - The version object containing name, description, release status, dates, and project ID.

### Request Example
```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Issue\Version;
use JiraRestApi\Project\ProjectService;
use JiraRestApi\Version\VersionService;
use JiraRestApi\JiraException;

try {
    $projectService = new ProjectService();
    $project = $projectService->get('TEST');

    $versionService = new VersionService();

    $version = new Version();

    $version->setName('1.0.0')
            ->setDescription('Generated by script')
            ->setReleased(true)
            ->setStartDateAsDateTime(new \DateTime())
            ->setReleaseDateAsDateTime((new \DateTime())->add(date_interval_create_from_date_string('1 months 3 days')))
            ->setProjectId($project->id)
            ;

    $res = $versionService->create($version);

    var_dump($res);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}
```

### Response
Returns the created version object.
```

--------------------------------

### Example: token-based cloud auth with ArrayConfiguration

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/02-configuration.md

Shows how to instantiate IssueService with an ArrayConfiguration for token-based authentication to Jira Cloud. Sets host, token, and logging options.

```php
use JiraRestApi\Configuration\ArrayConfiguration;
use JiraRestApi\Issue\IssueService;

$iss = new IssueService(new ArrayConfiguration([
    'jiraHost'            => 'https://your-jira.atlassian.net',
    'useTokenBasedAuth'   => true,
    'personalAccessToken' => 'your-token',
    'jiraLogEnabled'      => true,
    'jiraLogFile'         => 'my-jira.log',
    'jiraLogLevel'        => 'INFO',
]));
```

--------------------------------

### GET {api}/priority

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/endpoints.md

Retrieves all priorities.

```APIDOC
## GET {api}/priority

### Description
Retrieves all priorities.

### Method
GET

### Endpoint
{api}/priority

### Response
#### Success Response (200)
- **priorities** (array) - List of priorities.

#### Response Example
[
  {"id": "1", "name": "Highest"}
]
```

--------------------------------

### Update Project with ProjectService::updateProject

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

Updates a project by key 'EX'. Only non-null values sent in JSON are updated. The assigneeType field accepts 'PROJECT_LEAD' and 'UNASSIGNED'.

```php
<?php
require 'vendor/autoload.php';

use JiraRestApi\Project\ProjectService;
use JiraRestApi\Project\Project;
use JiraRestApi\JiraException;

try {
    $p = new Project();

    $p->setName('Updated Example')
        ->setProjectTypeKey('software')
        ->setProjectTemplateKey('com.atlassian.jira-software-project-templates:jira-software-project-management')
        ->setDescription('Updated Example Project description')
        ->setLead('new-leader')
        ->setUrl('http://new.example.com')
        ->setAssigneeType('UNASSIGNED')
    ;

    $proj = new ProjectService();

    $pj = $proj->updateProject($p, 'EX');
   
    var_dump($pj);
} catch (JiraRestApi\JiraException $e) {
    print('Error Occured! ' . $e->getMessage());
}
```

--------------------------------

### NoOperationMonologHandler and NoOperationMonologHandlerV3 class definitions

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/11-support-classes.md

Installed by JiraClient::__construct when getJiraLogEnabled() is false. They discard all log records, avoiding file writes when logging is disabled. The Monolog 2 variant vs Monolog 3 variant is selected based on the installed Monolog major version.

```php
class NoOperationMonologHandler extends AbstractProcessingHandler
{
    protected function write(array $record): void { /* no-op */ }
}

class NoOperationMonologHandlerV3 extends AbstractProcessingHandler
{
    protected function write(LogRecord $record): void { /* no-op */ }
}
```

--------------------------------

### Require Composer autoloader

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/README.md

After installation, include Composer's autoloader in your PHP script.

```php
require 'vendor/autoload.php';
```

--------------------------------

### getConfiguration(): ConfigurationInterface

Source: https://github.com/lesstif/php-jira-rest-client/blob/main/_autodocs/api-reference/00-architecture.md

Exposes the active configuration object.

```APIDOC
## getConfiguration(): ConfigurationInterface

### Description
Exposes the active configuration object.

### Method
`getConfiguration`

### Returns
- **ConfigurationInterface** - The active configuration instance.
```
Tokens:
Raw