Class Github\Api\Issue

InheritanceGithub\Api\Issue » Github\Api\AbstractApi
ImplementsGithub\Api\ApiInterface

Listing issues, searching, editing and closing your projects issues.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Github\Api\AbstractApi
all() List issues by username, repo and state. Github\Api\Issue
comments() List an issue comments. Github\Api\Issue
configure() Github\Api\AbstractApi
create() Create a new issue for the given username and repo. Github\Api\Issue
events() List all project events. Github\Api\Issue
find() Search issues by username, repo, state and keyword. Github\Api\Issue
getPerPage() Github\Api\AbstractApi
labels() List all project labels. Github\Api\Issue
milestones() List all project milestones. Github\Api\Issue
org() List issues by organization. Github\Api\Issue
setPerPage() Github\Api\AbstractApi
show() Get extended information about an issue by its username, repo and number. Github\Api\Issue
update() Update issue information's by username, repo and issue number. Requires authentication. Github\Api\Issue

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createJsonBody() Create a JSON encoded version of an array of parameters. Github\Api\AbstractApi
delete() Send a DELETE request with JSON-encoded parameters. Github\Api\AbstractApi
get() Send a GET request with query parameters. Github\Api\AbstractApi
head() Send a HEAD request with query parameters. Github\Api\AbstractApi
patch() Send a PATCH request with JSON-encoded parameters. Github\Api\AbstractApi
post() Send a POST request with JSON-encoded parameters. Github\Api\AbstractApi
postRaw() Send a POST request with raw data. Github\Api\AbstractApi
put() Send a PUT request with JSON-encoded parameters. Github\Api\AbstractApi

Method Details

all() public method

List issues by username, repo and state.

public array all ( $username, $repository, array $params = [] )
$username string

The username

$repository string

The repository

$params array

The additional parameters like milestone, assignees, labels, sort, direction

return array

List of issues found

comments() public method

List an issue comments.

public Github\Api\Issue\Comments comments ( )
create() public method

Create a new issue for the given username and repo.

The issue is assigned to the authenticated user. Requires authentication.

public array create ( $username, $repository, array $params )
$username string

The username

$repository string

The repository

$params array

The new issue data

return array

Information about the issue

throws Github\Exception\MissingArgumentException
events() public method

List all project events.

public Github\Api\Issue\Events events ( )
find() public method

Search issues by username, repo, state and keyword.

public array find ( $username, $repository, $state, $keyword )
$username string

The username

$repository string

The repository

$state string

The issue state, can be open or closed

$keyword string

The keyword to filter issues by

return array

List of issues found

labels() public method

List all project labels.

public Github\Api\Issue\Labels labels ( )
milestones() public method

List all project milestones.

public Github\Api\Issue\Milestones milestones ( )
org() public method

List issues by organization.

public array org ( $organization, $state, array $params = [] )
$organization string

The organization

$state string

The issue state, can be open or closed

$params array

The additional parameters like milestone, assignees, labels, sort, direction

return array

List of issues found

show() public method

Get extended information about an issue by its username, repo and number.

public array show ( $username, $repository, $id )
$username string

The username

$repository string

The repository

$id string

The issue number

return array

Information about the issue

update() public method

Update issue information's by username, repo and issue number. Requires authentication.

public array update ( $username, $repository, $id, array $params )
$username string

The username

$repository string

The repository

$id string

The issue number

$params array

Key=>value user attributes to update.

                      key can be title or body
return array

Information about the issue