jira-php

Very simple classes that search JIRA via REST API.

Usage

require_once('JIRA.php');

Create object of JIRA

$jira = new JIRA('https://jira.atlassian.com', 'username', 'password');

Search with JQL query as the only parameter. Returned value is in PHP object format.

$result = $jira->search_issues('updated > startOfDay("-7")');

Search with extra parameters. Write both JQL query and the extra parameter in an array.

$result = $jira->search_issues([ 'updated > startOfDay("-7")', 'fields' => [''] ]);

Another example with more parameters

$result = $jira->search_issues([
    'updated > startOfDay("-60") and updated < startOfDay("-30")',
    'fields' => ['project', 'worklog'],
    'startAt' => 0,
    'maxResults' => 50
]);

Another example

$jql = 'updated > startOfDay("-60") and updated < startOfDay("-30")';
$fields = ['project', 'worklog'];
$start_at = 0;
$max_results = 50;

$result = $jira->search_issues([
    $jql,
    'fields' => $fields,
    'startAt' => $start_at,
    'maxResults' => $max_results
]);

Use PHP function, property_exists(), to check whether JIRA returned an error message.

if (property_exists($result, 'errors')) {
    echo "[JIRA] Error messages: " . $jira->error_messages();
    exit(1);
}

All parameters can be written in JSON string format

$result = $jira->search_issues('{
    "jql": "updated > startOfDay("-7")",
    "fields": ""
}');

To have result returned in JSON format, use function query_use_get() or query_use_post(), and add "true" as third parameter.

$parameters = '{ "jql": "issue = 35213", "fields": [""], "expand": ["changelog"] }';
$json_result = $jira->query_use_post('search', $parameters, true);