JGithubPackagePullsComments

class JGithubPackagePullsComments extends JGithubPackage

GitHub API Pulls Comments class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject

JGithubPackage

__get( string $name)

Magic method to lazily create API objects

from JGithubPackage

object

create( string $user, string $repo, integer $pullId, string $body, string $commitId, string $filePath, string $position)

Method to create a comment on a pull request.

object

createReply( string $user, string $repo, integer $pullId, string $body, integer $inReplyTo)

Method to create a comment in reply to another comment.

void

delete( string $user, string $repo, integer $commentId)

Method to delete a comment on a pull request.

object

edit( string $user, string $repo, integer $commentId, string $body)

Method to update a comment on a pull request.

object

get( string $user, string $repo, integer $commentId)

Method to get a specific comment on a pull request.

array

getList( string $user, string $repo, integer $pullId, integer $page, integer $limit)

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

Details

`__construct( Registry $options = null, JGithubHttp $client = null)`

Constructor.

Parameters

Registry	$options	GitHub options object.
JGithubHttp	$client	The HTTP client object.

`JGithubPackage __get( string $name)`

Magic method to lazily create API objects

Parameters

string

$name

Name of property to retrieve

Return Value

JGithubPackage

GitHub API package object.

Exceptions

RuntimeException

`object create( string $user, string $repo, integer $pullId, string $body, string $commitId, string $filePath, string $position)`

Method to create a comment on a pull request.

Parameters

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.

Return Value

object

Exceptions

DomainException

`object createReply( string $user, string $repo, integer $pullId, string $body, integer $inReplyTo)`

Method to create a comment in reply to another comment.

Parameters

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.

Return Value

object

Exceptions

DomainException

`void delete( string $user, string $repo, integer $commentId)`

Method to delete a comment on a pull request.

Parameters

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.

Return Value

void

Exceptions

DomainException

`object edit( string $user, string $repo, integer $commentId, string $body)`

Method to update a comment on a pull request.

Parameters

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.

Return Value

object

Exceptions

DomainException

`object get( string $user, string $repo, integer $commentId)`

Method to get a specific comment on a pull request.

Parameters

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.

Return Value

object

Exceptions

DomainException

`array getList( string $user, string $repo, integer $pullId, integer $page, integer $limit)`

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

Parameters

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.

Return Value

array

Exceptions

DomainException