Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 2.57 KB

issues.md

File metadata and controls

98 lines (64 loc) · 2.57 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

$issues = $client->api('issue')->find('KnpLabs', 'php-github-api', 'closed', 'bug');

Returns an array of closed issues matching the "bug" term. For more complex searches, use the search api which supports the advanced GitHub search syntax.

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', array('title' => 'The issue title', 'body' => 'The issue body'));

Creates a new issue in the repo "php-github-api" 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);