JGithubPackageRepositoriesMerging
Extends \JGithubPackageGitHub API Repositories Merging class for the Joomla Platform.
| documentation | |
|---|---|
| since |
1.7.3 |
| 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.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $name
stringName of property to retrieve
Response
\JGithubPackageGitHub API package 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.
perform
Perform a merge.
perform(string $owner, string $repo, string $base, string $head, string $commitMessage = '') : boolean
| throws |
|
|---|---|
| since |
3.3.0 |
Arguments
- $owner
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $base
stringThe name of the base branch that the head will be merged into.- $head
stringThe head to merge. This can be a branch name or a commit SHA1.- $commitMessage
stringCommit message to use for the merge commit. If omitted, a default message will be used.
Response
boolean
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
name
| since |
3.3 |
|---|
Type(s)
string
packages
| since |
3.3 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.