Class JGithubRefs
GitHub API References class for the Joomla Platform.
-
JGithubObject
-
JGithubRefs
Methods summary
public
object
|
#
create( string $user, string $repo, string $ref, string $sha )
Method to create an issue.
Method to create an issue.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.
- $repo
string - $repo The name of the GitHub repository.
- $ref
string - $ref The name of the fully qualified reference.
- $sha
string - $sha The SHA1 value to set this reference to.
Returns
object
Since
11.3
|
public
object
|
#
edit( string $user, string $repo, string $ref, string $sha, string $force = false )
Method to update a reference.
Method to update a reference.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.
- $repo
string - $repo The name of the GitHub repository.
- $ref
string - $ref The reference to update.
- $sha
string - $sha The SHA1 value to set the reference to.
- $force
string - $force Whether the update should be forced. Default to false.
Returns
object
Since
11.3
|
public
object
|
#
get( string $user, string $repo, string $ref )
Method to get a reference.
Method to get a reference.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.
- $repo
string - $repo The name of the GitHub repository.
- $ref
string - $ref The reference to get.
Returns
object
Since
11.3
|
public
array
|
#
getList( string $user, string $repo, string $namespace = '', integer $page = 0, integer $limit = 0 )
Method to list references for a repository.
Method to list references 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.
- $namespace
string - $namespace Optional sub-namespace to limit the returned references.
- $page
integer - $page Page to request
- $limit
integer - $limit Number of results to return per page
Returns
array
Since
11.3
|
__construct()
,
fetchUrl()
,
processResponse()
Magic methods summary
Properties summary
$client
,
$options