Référence de la classe JGithubPulls

Graphe d'héritage de JGithubPulls:

Graphe de collaboration de JGithubPulls:

Liste de tous les membres

Fonctions membres publiques
	create ($user, $repo, $title, $base, $head, $body= '')
	createComment ($user, $repo, $pullId, $body, $commitId, $filePath, $position)
	createCommentReply ($user, $repo, $pullId, $body, $inReplyTo)
	createFromIssue ($user, $repo, $issueId, $base, $head)
	deleteComment ($user, $repo, $commentId)
	edit ($user, $repo, $pullId, $title=null, $body=null, $state=null)
	editComment ($user, $repo, $commentId, $body)
	get ($user, $repo, $pullId)
	getComment ($user, $repo, $commentId)
	getComments ($user, $repo, $pullId, $page=0, $limit=0)
	getCommits ($user, $repo, $pullId, $page=0, $limit=0)
	getFiles ($user, $repo, $pullId, $page=0, $limit=0)
	getList ($user, $repo, $state= 'open', $page=0, $limit=0)
	isMerged ($user, $repo, $pullId)
	merge ($user, $repo, $pullId, $message= '')
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

JGithubPulls::create	(		$user,
			$repo,
			$title,
			$base,
			$head,
			$body = ''
	)

Method to create a pull request.

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 pull request.
string	$base	The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
string	$head	The branch (or git ref) where your changes are implemented.
string	$body	The body text for the new pull request.

Renvoie:

object

Depuis:

11.3

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

JGithubPulls::createComment	(		$user,
			$repo,
			$pullId,
			$body,
			$commitId,
			$filePath,
			$position
	)

Method to create a comment on a pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request number.
string	$body	The comment body text.
string	$commitId	The SHA1 hash of the commit to comment on.
string	$filePath	The Relative path of the file to comment on.
string	$position	The line index in the diff to comment on.

Renvoie:

object

Depuis:

11.3

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

JGithubPulls::createCommentReply	(		$user,
			$repo,
			$pullId,
			$body,
			$inReplyTo
	)

Method to create a comment in reply to another comment.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request number.
string	$body	The comment body text.
integer	$inReplyTo	The id of the comment to reply to.

Renvoie:

object

Depuis:

11.3

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

JGithubPulls::createFromIssue	(		$user,
			$repo,
			$issueId,
			$base,
			$head
	)

Method to create a pull request from an existing 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 for which to attach the new pull request.
string	$base	The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
string	$head	The branch (or git ref) where your changes are implemented.

Renvoie:

object

Depuis:

11.3

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

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

Method to delete a comment on a pull request.

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.

JGithubPulls::edit	(		$user,
			$repo,
			$pullId,
			$title = null,
			$body = null,
			$state = null
	)

Method to update a pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request number.
string	$title	The optional new title for the pull request.
string	$body	The optional new body text for the pull request.
string	$state	The optional new state for the pull request. [open, closed]

Renvoie:

object

Depuis:

11.3

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

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

Method to update a comment on a pull request.

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.

JGithubPulls::get	(		$user,
			$repo,
			$pullId
	)

Method to get a single pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request number.

Renvoie:

object

Depuis:

11.3

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

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

Method to get a specific comment on a pull request.

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.

JGithubPulls::getComments	(		$user,
			$repo,
			$pullId,
			$page = 0,
			$limit = 0
	)

Method to get the list of comments on a pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request 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.

JGithubPulls::getCommits	(		$user,
			$repo,
			$pullId,
			$page = 0,
			$limit = 0
	)

Method to get a list of commits for a pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request 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.

JGithubPulls::getFiles	(		$user,
			$repo,
			$pullId,
			$page = 0,
			$limit = 0
	)

Method to get a list of files for a pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request 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.

JGithubPulls::getList	(		$user,
			$repo,
			$state = 'open',
			$page = 0,
			$limit = 0
	)

Method to list pull requests.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$state	The optional state to filter requests by. [open, closed]
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, $state, et $user.

JGithubPulls::isMerged	(		$user,
			$repo,
			$pullId
	)

Method to check if a pull request has been merged.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request number. The pull request number.

Renvoie:

boolean True if the pull request has been merged.

Depuis:

11.3

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

JGithubPulls::merge	(		$user,
			$repo,
			$pullId,
			$message = ''
	)

Method to merge a pull request.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$pullId	The pull request number.
string	$message	The message that will be used for the merge commit.

Renvoie:

object

Depuis:

11.3

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

---

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

• pulls.php