Référence de la classe JGithubIssues

Graphe d'héritage de JGithubIssues:

Graphe de collaboration de JGithubIssues:

Liste de tous les membres

Fonctions membres publiques
	create ($user, $repo, $title, $body=null, $assignee=null, $milestone=null, array $labels=null)
	createComment ($user, $repo, $issueId, $body)
	deleteComment ($user, $repo, $commentId)
	edit ($user, $repo, $issueId, $state=null, $title=null, $body=null, $assignee=null, $milestone=null, array $labels=null)
	editComment ($user, $repo, $commentId, $body)
	get ($user, $repo, $issueId)
	getComment ($user, $repo, $commentId)
	getComments ($user, $repo, $issueId, $page=0, $limit=0)
	getList ($filter=null, $state=null, $labels=null, $sort=null, $direction=null, JDate $since=null, $page=0, $limit=0)
	getListByRepository ($user, $repo, $milestone=null, $state=null, $assignee=null, $mentioned=null, $labels=null, $sort=null, $direction=null, JDate $since=null, $page=0, $limit=0)
Fonctions membres publiques inherited from JGithubObject
	__construct (JRegistry &$options=null, JGithubHttp $client=null)

Additional Inherited Members
Fonctions membres protégées inherited from JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
Attributs protégés inherited from JGithubObject
	$options
	$client

---

Documentation des fonctions membres

JGithubIssues::create	(		$user,
			$repo,
			$title,
			$body = null,
			$assignee = null,
			$milestone = null,
		array	$labels = null
	)

Method to create an issue.

Paramètres:

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.

Renvoie:

object

Depuis:

11.3

Références $data, $path, $title, et $user.

JGithubIssues::createComment	(		$user,
			$repo,
			$issueId,
			$body
	)

Method to create a comment on an issue.

Paramètres:

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.

Renvoie:

object

Depuis:

11.3

Références $data, $path, et $user.

JGithubIssues::deleteComment	(		$user,
			$repo,
			$commentId
	)

Method to delete a comment on an issue.

Paramètres:

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.

Renvoie:

void

Depuis:

11.3

Références $path, et $user.

JGithubIssues::edit	(		$user,
			$repo,
			$issueId,
			$state = null,
			$title = null,
			$body = null,
			$assignee = null,
			$milestone = null,
		array	$labels = null
	)

Method to update an issue.

Paramètres:

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.

Renvoie:

object

Depuis:

11.3

Références $data, $path, $state, $title, et $user.

JGithubIssues::editComment	(		$user,
			$repo,
			$commentId,
			$body
	)

Method to update a comment on an issue.

Paramètres:

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.

Renvoie:

object

Depuis:

11.3

Références $data, $path, et $user.

JGithubIssues::get	(		$user,
			$repo,
			$issueId
	)

Method to get a single issue.

Paramètres:

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

Renvoie:

object

Depuis:

11.3

Références $path, et $user.

JGithubIssues::getComment	(		$user,
			$repo,
			$commentId
	)

Method to get a specific comment on an issue.

Paramètres:

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.

Renvoie:

object

Depuis:

11.3

Références $path, et $user.

JGithubIssues::getComments	(		$user,
			$repo,
			$issueId,
			$page = 0,
			$limit = 0
	)

Method to get the list of comments on an issue.

Paramètres:

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.

Renvoie:

array

Depuis:

11.3

Références $limit, $path, et $user.

JGithubIssues::getList	(		$filter = null,
			$state = null,
			$labels = null,
			$sort = null,
			$direction = null,
		JDate	$since = null,
			$page = 0,
			$limit = 0
	)

Method to list an authenticated user's issues.

Paramètres:

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,.
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.

Renvoie:

array

Depuis:

11.3

Références $limit, et $path.

JGithubIssues::getListByRepository	(		$user,
			$repo,
			$milestone = null,
			$state = null,
			$assignee = null,
			$mentioned = null,
			$labels = null,
			$sort = null,
			$direction = null,
		JDate	$since = null,
			$page = 0,
			$limit = 0
	)

Method to list issues.

Paramètres:

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,.
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.

Renvoie:

array

Depuis:

11.3

Références $limit, $path, et $user.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• issues.php