Graphe d'héritage de JGithubPackagePulls:

Fonctions membres publiques
	create ($user, $repo, $title, $base, $head, $body='')

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

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

	get ($user, $repo, $pullId)

	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='')

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

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

	deleteComment ($user, $repo, $commentId)

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

	getComment ($user, $repo, $commentId)

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

Fonctions membres publiques hérités de JGithubPackage
	__get ($name)

Fonctions membres publiques hérités de JGithubObject
	__construct (Registry $options=null, JGithubHttp $client=null)

Attributs protégés
	$name = 'Pulls'

	$packages

Attributs protégés hérités de JGithubPackage
	$name = ''

	$packages = array()

Attributs protégés hérités de JGithubObject
	$options

	$client

Membres hérités additionnels
Fonctions membres protégées hérités de JGithubObject
	fetchUrl ($path, $page=0, $limit=0)

	processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)

Documentation des fonctions membres

◆ create()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: object

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

◆ createComment()

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.

Obsolète:: use pulls->comments->create()

Renvoie: object

Depuis: 1.7.3

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

◆ createCommentReply()

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.

Obsolète:: use pulls->comments->createReply()

Renvoie: object

Depuis: 1.7.3

Références $user.

◆ createFromIssue()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: object

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

◆ deleteComment()

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.

Obsolète:: use pulls->comments->delete()

Renvoie: void

Depuis: 1.7.3

Références $user.

◆ edit()

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]

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: object

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

◆ editComment()

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.

Obsolète:: use pulls->comments->edit()

Renvoie: object

Depuis: 1.7.3

Références $user.

◆ get()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: object

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

◆ getComment()

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.

Obsolète:: use pulls->comments->get()

Renvoie: object

Depuis: 1.7.3

Références $user.

◆ getComments()

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.

Obsolète:: use pulls->comments->getList()

Renvoie: array

Depuis: 1.7.3

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

◆ getCommits()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: array

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

◆ getFiles()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: array

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

◆ getList()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: array

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

◆ isMerged()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: boolean True if the pull request has been merged.

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

◆ merge()

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.

Exceptions

DomainException

Depuis: 1.7.3

Renvoie: object

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

Documentation des champs

◆ $name

$name = 'Pulls'

protected

◆ $packages

$packages

protected

Valeur initiale :

= array(
                'comments',
        )

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

pulls.php

Fonctions membres publiques

Attributs protégés

Membres hérités additionnels

Documentation des fonctions membres

◆ create()

◆ createComment()

◆ createCommentReply()

◆ createFromIssue()

◆ deleteComment()

◆ edit()

◆ editComment()

◆ get()

◆ getComment()

◆ getComments()

◆ getCommits()

◆ getFiles()

◆ getList()

◆ isMerged()

◆ merge()

Documentation des champs

◆ $name

◆ $packages