Class JGithubPackageRepositoriesComments
GitHub API Repositories Comments class for the Joomla Platform.
-
JGithubObject
-
JGithubPackage
-
JGithubPackageRepositoriesComments
Methods summary
public
array
|
#
getListRepository( string $user, string $repo, integer $page = 0, integer $limit = 0 )
Method to get a list of commit comments for a repository.
Method to get a list of commit comments for a repository.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $page
integer - $page Page to request- $limit
integer - $limit Number of results to return per page Returns
array
Since
12.1
|
public
array
|
#
getList( string $user, string $repo, string $sha, integer $page = 0, integer $limit = 0 )
Method to get a list of comments for a single commit for a repository.
Method to get a list of comments for a single commit for a repository.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $sha
string - $sha The SHA of the commit to retrieve.- $page
integer - $page Page to request- $limit
integer - $limit Number of results to return per page Returns
array
Since
12.1
|
public
array
|
#
get( string $user, string $repo, integer $id )
Method to get a single comment on a commit.
Method to get a single comment on a commit.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
integer - $id ID of the comment to retrieve Returns
array
Since
12.1
|
public
object
|
#
edit( string $user, string $repo, string $id, string $comment )
Method to edit a comment on a commit.
Method to edit a comment on a commit.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
string - $id The ID of the comment to edit.- $comment
string - $comment The text of the comment. Returns
object
Since
12.1
|
public
object
|
#
delete( string $user, string $repo, string $id )
Method to delete a comment on a commit.
Method to delete a comment on a commit.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
string - $id The ID of the comment to edit. Returns
object
Since
12.1
|
public
object
|
#
create( string $user, string $repo, string $sha, string $comment, integer $line, string $filepath, integer $position )
Method to create a comment on a commit.
Method to create a comment on a commit.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $sha
string - $sha The SHA of the commit to comment on.- $comment
string - $comment The text of the comment.- $line
integer - $line The line number of the commit to comment on.- $filepath
string - $filepath A relative path to the file to comment on within the commit.- $position
integer - $position Line index in the diff to comment on. Returns
object
Since
12.1
|
__get()
__construct(),
fetchUrl(),
processResponse()
Magic methods summary
Properties summary
$name,
$packages
$client,
$options
