Référence de la classe JGithubPackagePullsComments

Graphe d'héritage de JGithubPackagePullsComments:

Fonctions membres publiques
	create ($user, $repo, $pullId, $body, $commitId, $filePath, $position)
	createReply ($user, $repo, $pullId, $body, $inReplyTo)
	delete ($user, $repo, $commentId)
	edit ($user, $repo, $commentId, $body)
	get ($user, $repo, $commentId)
	getList ($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)

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)
Attributs protégés hérités de JGithubPackage
	$name = ''
	$packages = array()
Attributs protégés hérités de JGithubObject
	$options
	$client

Description détaillée

GitHub API Pulls Comments class for the Joomla Platform.

https://developer.github.com/v3/pulls/comments/

Depuis

3.3 (CMS)

Obsolète:

4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

create()

create	(		$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.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

object

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

createReply()

createReply	(		$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.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

object

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

delete()

delete	(		$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.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

void

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

edit()

edit	(		$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.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

object

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

get()

get	(		$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.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

object

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

getList()

getList	(		$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.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

array

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

---

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

• github/package/pulls/comments.php