Skip to content

issues.md

Latest commit

 

History

History
99 lines (65 loc) · 2.79 KB

issues.md

File metadata and controls

99 lines (65 loc) · 2.79 KB
Raw

Issues API

Back to the navigation

Listing issues, searching, editing and closing your projects issues. Wraps GitHub Issue API.

Additional APIs:

List issues in a project

$issues = $client->api('issue')->all('KnpLabs', 'php-github-api', array('state' => 'open'));

Returns an array of issues.

Search issues in a project

$result = $client->api('search')->issues('repo:KnpLabs/php-github-api is:issue is:closed bug');
$issues = $result['items'];

Uses the Search API to find closed issues in this repository matching the "bug" term. The search response contains total_count, incomplete_results, and items; $issues contains the issues from the returned page. The is:issue qualifier excludes pull requests.

Get information about an issue

$issue = $client->api('issue')->show('KnpLabs', 'php-github-api', 1);

Returns an array of information about the issue.

Open a new issue

Requires authentication.

$client->api('issue')->create('KnpLabs', 'php-github-api-example', array('title' => 'The issue title', 'body' => 'The issue body'));

Creates a new issue in the repo "php-github-api-example" (the repository in this example does not exist) of the user "KnpLabs". The issue is assigned to the authenticated user. Returns an array of information about the issue.

Close an issue

Requires authentication.

$client->api('issue')->update('KnpLabs', 'php-github-api', 4, array('state' => 'closed'));

Closes the fourth issue of the repo "php-github-api" of the user "KnpLabs". Returns an array of information about the issue.

Reopen an issue

Requires authentication.

$client->api('issue')->update('KnpLabs', 'php-github-api', 4, array('state' => 'open'));

Reopens the fourth issue of the repo "php-github-api" of the user "KnpLabs". Returns an array of information about the issue.

Update an issue

Requires authentication.

$client->api('issue')->update('KnpLabs', 'php-github-api', 4, array('body' => 'The new issue body'));

Updates the fourth issue of the repo "php-github-api" of the user "KnpLabs". Available attributes are title and body. Returns an array of information about the issue.

Search issues matching a label

$client->api('issue')->all('KnpLabs', 'php-github-api', array('labels' => 'label name'));

Returns an array of issues matching the given label.

Lock an issue discussion

$client->api('issue')->lock('KnpLabs', 'php-github-api', 4);

Unlock an issue discussion

$client->api('issue')->unlock('KnpLabs', 'php-github-api', 4);