Pulls
Extends AbstractPackageGitHub API Pull Requests class for the Joomla Framework.
| link | |
|---|---|
| since |
1.0 |
| property-read Comments |
GitHub API object for comments. |
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
create
Create a pull request.
create( user, repo, title, base, head, body = '') :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- title
stringThe title of the new pull request.- base
stringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.- head
stringThe branch (or git ref) where your changes are implemented.- body
stringThe body text for the new pull request.
Response
object
createFromIssue
Method to create a pull request from an existing issue.
createFromIssue( user, repo, issueId, base, head) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- issueId
intThe issue number for which to attach the new pull request.- base
stringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.- head
stringThe branch (or git ref) where your changes are implemented.
Response
object
edit
Update a pull request.
edit( user, repo, pullId, title = null, body = null, state = null, base = null) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- pullId
intThe pull request number.- title
stringThe optional new title for the pull request.- body
stringThe optional new body text for the pull request.- state
stringThe optional new state for the pull request. [open, closed]- base
stringThe optional new base branch for the pull request.
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( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
get
Get a single pull request.
get( user, repo, pullId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- pullId
intThe pull request number.
Response
object
getCommits
List commits on a pull request.
getCommits( user, repo, pullId, page, limit) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- pullId
intThe pull request number.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
object
getFiles
List pull requests files.
getFiles( user, repo, pullId, page, limit) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- pullId
intThe pull request number.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
object
getList
List pull requests.
getList( user, repo, state = 'open', page, limit) : mixed||string|int
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- state
stringThe optional state to filter requests by. [open, closed]- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
array<string|int, mixed>
isMerged
Get if a pull request has been merged.
isMerged( user, repo, pullId) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- pullId
intThe pull request number. The pull request number.
Response
boolTrue if the pull request has been merged
merge
Merge a pull request (Merge Button).
merge( user, repo, pullId, message = '') :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- pullId
intThe pull request number.- message
stringThe message that will be used for the merge commit.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
Properties
comments
package
The package the object resides in
| since |
1.0 |
|---|
Type(s)
string
hookEvents
Array containing the allowed hook events
| since |
1.5.2 |
|---|---|
| link | |
| note |
From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses |
Type(s)
array<string|int, mixed>