JGithubStatuses
Extends \JGithubObjectGitHub API References class for the Joomla Platform.
| since |
3.1.4 |
|---|---|
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
| since |
1.7.3 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGitHub options object.- $client
\JGithubHttpThe HTTP client object.
create
Method to create a status.
create(string $user, string $repo, string $sha, string $state, string $targetUrl = null, string $description = null) : object
| deprecated |
use repositories->statuses->create() |
|---|---|
| since |
3.1.4 |
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $sha
stringThe SHA1 value for which to set the status.- $state
stringThe state (pending, success, error or failure).- $targetUrl
stringOptional target URL.- $description
stringOptional description for the status.
Response
object
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $page, integer $limit) : string
| since |
1.7.3 |
|---|
Arguments
- $path
stringURL to inflect- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
getList
Method to list statuses for an SHA.
getList(string $user, string $repo, string $sha) : array
| deprecated |
use repositories->statuses->getList() |
|---|---|
| since |
3.1.4 |
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $sha
stringSHA1 for which to get the statuses.
Response
array
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
| throws |
|
|---|---|
| since |
3.3.0 |
Arguments
- $response
\JHttpResponseThe response.- $expectedCode
integerThe expected "good" code.- $decode
booleanIf the should be response be JSON decoded.
Response
mixed
Properties
client
The HTTP client object to use in sending HTTP requests.