class JGithubPackageRepositoriesComments extends JGithubPackage

GitHub API Repositories Comments class for the Joomla Platform.

Methods

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

Constructor.

__get( string $name)

Magic method to lazily create API objects

array
getListRepository( string $user, string $repo, integer $page, integer $limit)

Method to get a list of commit comments for a repository.

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

Method to get a list of comments for a single commit for a repository.

array
get( string $user, string $repo, integer $id)

Method to get a single comment on a commit.

object
edit( string $user, string $repo, string $id, string $comment)

Method to edit a comment on a commit.

object
delete( string $user, string $repo, string $id)

Method to delete a comment on a commit.

object
create( string $user, string $repo, string $sha, string $comment, integer $line, string $filepath, integer $position)

Method to create a comment on a commit.

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

array getListRepository( string $user, string $repo, integer $page, integer $limit)

Method to get a list of commit comments for a repository.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $page Page to request
integer $limit Number of results to return per page

Return Value

array

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

Method to get a list of comments for a single commit for a repository.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $sha The SHA of the commit to retrieve.
integer $page Page to request
integer $limit Number of results to return per page

Return Value

array

array get( string $user, string $repo, integer $id)

Method to get a single comment on a commit.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $id ID of the comment to retrieve

Return Value

array

object edit( string $user, string $repo, string $id, string $comment)

Method to edit a comment on a commit.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $id The ID of the comment to edit.
string $comment The text of the comment.

Return Value

object

object delete( string $user, string $repo, string $id)

Method to delete a comment on a commit.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $id The ID of the comment to edit.

Return Value

object

object create( string $user, string $repo, string $sha, string $comment, integer $line, string $filepath, integer $position)

Method to create a comment on a commit.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $sha The SHA of the commit to comment on.
string $comment The text of the comment.
integer $line The line number of the commit to comment on.
string $filepath A relative path to the file to comment on within the commit.
integer $position Line index in the diff to comment on.

Return Value

object