Docs For Class JGithubIssues

JGithubIssues

Description

GitHub API Issues class for the Joomla Platform.

since: 11.3

Located in /libraries/joomla/github/issues.php (line 19)

JGithubObject
   |
   --JGithubIssues

Method Summary

object create (string $user, string $repo, string $title, [string $body = null], [string $assignee = null], [integer $milestone = null], [array $labels = null])

object createComment (string $user, string $repo, integer $issueId, string $body)

object createLabel (string $user, string $repo, string $name, string $color)

void deleteComment (string $user, string $repo, integer $commentId)

object deleteLabel (string $user, string $repo, string $label)

object edit (string $user, string $repo, integer $issueId, [string $state = null], [string $title = null], [string $body = null], [string $assignee = null], [integer $milestone = null], [array $labels = null])

object editComment (string $user, string $repo, integer $commentId, string $body)

object editLabel (string $user, string $repo, string $label, string $name, string $color)

object get (string $user, string $repo, integer $issueId)

object getComment (string $user, string $repo, integer $commentId)

array getComments (string $user, string $repo, integer $issueId, [integer $page = 0], [integer $limit = 0])

object getLabel (string $user, string $repo, string $name)

array getLabels (string $user, string $repo)

array getList ([string $filter = null], [string $state = null], [string $labels = null], [string $sort = null], [string $direction = null], [JDate $since = null], [integer $page = 0], [integer $limit = 0])

array getListByRepository (string $user, string $repo, [string $milestone = null], [string $state = null], [string $assignee = null], [string $mentioned = null], [string $labels = null], [string $sort = null], [string $direction = null], [JDate $since = null], [integer $page = 0], [integer $limit = 0])

Variables

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
JGithubObject::$options

Methods

create (line 36)

Method to create an issue.

since: 11.3
access: public

object create (string $user, string $repo, string $title, [string $body = null], [string $assignee = null], [integer $milestone = null], [array $labels = null])

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
string $title: The title of the new issue.
string $body: The body text for the new issue.
string $assignee: The login for the GitHub user that this issue should be assigned to.
integer $milestone: The milestone to associate this issue with.
array $labels: The labels to associate with this issue.

createComment (line 84)

Method to create a comment on an issue.

since: 11.3
access: public

object createComment (string $user, string $repo, integer $issueId, string $body)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $issueId: The issue number.
string $body: The comment body text.

createLabel (line 122)

Method to create a label on a repo.

since: 12.3
access: public

object createLabel (string $user, string $repo, string $name, string $color)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
string $name: The label name.
string $color: The label color.

deleteComment (line 160)

Method to delete a comment on an issue.

since: 11.3
access: public

void deleteComment (string $user, string $repo, integer $commentId)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $commentId: The id of the comment to delete.

deleteLabel (line 188)

Method to delete a label on a repo.

since: 12.3
access: public

object deleteLabel (string $user, string $repo, string $label)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
string $label: The label name.

edit (line 222)

Method to update an issue.

since: 11.3
access: public

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $issueId: The issue number.
string $state: The optional new state for the issue. [open, closed]
string $title: The title of the new issue.
string $body: The body text for the new issue.
string $assignee: The login for the GitHub user that this issue should be assigned to.
integer $milestone: The milestone to associate this issue with.
array $labels: The labels to associate with this issue.

editComment (line 301)

Method to update a comment on an issue.

since: 11.3
access: public

object editComment (string $user, string $repo, integer $commentId, string $body)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $commentId: The id of the comment to update.
string $body: The new body text for the comment.

editLabel (line 340)

Method to update a label on a repo.

since: 12.3
access: public

object editLabel (string $user, string $repo, string $label, string $name, string $color)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
string $label: The label name.
string $name: The label name.
string $color: The label color.

get (line 378)

Method to get a single issue.

since: 11.3
access: public

object get (string $user, string $repo, integer $issueId)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $issueId: The issue number.

getComment (line 408)

Method to get a specific comment on an issue.

since: 11.3
access: public

object getComment (string $user, string $repo, integer $commentId)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $commentId: The comment id to get.

getComments (line 440)

Method to get the list of comments on an issue.

since: 11.3
access: public

array getComments (string $user, string $repo, integer $issueId, [integer $page = 0], [integer $limit = 0])

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
integer $issueId: The issue number.
integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

getLabel (line 470)

Method to get a specific label on a repo.

since: 12.3
access: public

object getLabel (string $user, string $repo, string $name)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
string $name: The label name to get.

getLabels (line 499)

Method to get the list of labels on a repo.

since: 12.3
access: public

array getLabels (string $user, string $repo)

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.

getList (line 534)

Method to list an authenticated user's issues.

since: 11.3
access: public

string $filter: The filter type: assigned, created, mentioned, subscribed.
string $state: The optional state to filter requests by. [open, closed]
string $labels: The list of comma separated Label names. Example: bug,ui,@high.
string $sort: The sort order: created, updated, comments, default: created.
string $direction: The list direction: asc or desc, default: desc.
JDate $since: The date/time since when issues should be returned.
integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

getListByRepository (line 575)

Method to list issues.

since: 11.3
access: public

string $user: The name of the owner of the GitHub repository.
string $repo: The name of the GitHub repository.
string $milestone: The milestone number, 'none', or *.
string $state: The optional state to filter requests by. [open, closed]
string $assignee: The assignee name, 'none', or *.
string $mentioned: The GitHub user name.
string $labels: The list of comma separated Label names. Example: bug,ui,@high.
string $sort: The sort order: created, updated, comments, default: created.
string $direction: The list direction: asc or desc, default: desc.
JDate $since: The date/time since when issues should be returned.
integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()

Documentation generated on Tue, 19 Nov 2013 15:05:52 +0100 by phpDocumentor 1.4.3