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) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
GitHub options object.- client
\Joomla\Http\Http
The HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
since |
1.0 |
---|---|
throws |
|
Arguments
- name
string
Name of property to retrieve
Response
\Joomla\Github\AbstractPackage
GitHub API package object.
create
Create a pull request.
create(string user, string repo, string title, string base, string head, string body = '') : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- title
string
The title of the new pull request.- base
string
The 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
string
The branch (or git ref) where your changes are implemented.- body
string
The body text for the new pull request.
Response
object
createFromIssue
Method to create a pull request from an existing issue.
createFromIssue(string user, string repo, int issueId, string base, string head) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- issueId
int
The issue number for which to attach the new pull request.- base
string
The 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
string
The branch (or git ref) where your changes are implemented.
Response
object
edit
Update a pull request.
edit(string user, string repo, int pullId, string title = null, string body = null, string state = null, string base = null) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- pullId
int
The pull request number.- title
string
The optional new title for the pull request.- body
string
The optional new body text for the pull request.- state
string
The optional new state for the pull request. [open, closed]- base
string
The 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(string path, int page, int limit) : \Joomla\Uri\Uri
since |
1.0 |
---|
Arguments
- path
string
URL to inflect- page
int
Page to request- limit
int
Number of results to return per page
Response
\Joomla\Uri\Uri
get
Get a single pull request.
get(string user, string repo, int pullId) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- pullId
int
The pull request number.
Response
object
getCommits
List commits on a pull request.
getCommits(string user, string repo, int pullId, int page, int limit) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- pullId
int
The pull request number.- page
int
The page number from which to get items.- limit
int
The number of items on a page.
Response
object
getFiles
List pull requests files.
getFiles(string user, string repo, int pullId, int page, int limit) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- pullId
int
The pull request number.- page
int
The page number from which to get items.- limit
int
The number of items on a page.
Response
object
getList
List pull requests.
getList(string user, string repo, string state = 'open', int page, int limit) : array
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- state
string
The optional state to filter requests by. [open, closed]- page
int
The page number from which to get items.- limit
int
The number of items on a page.
Response
array
isMerged
Get if a pull request has been merged.
isMerged(string user, string repo, int pullId) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- pullId
int
The pull request number. The pull request number.
Response
bool
True if the pull request has been merged
merge
Merge a pull request (Merge Button).
merge(string user, string repo, int pullId, string message = '') : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- pullId
int
The pull request number.- message
string
The message that will be used for the merge commit.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response.- expectedCode
int
The expected "good" code.
Response
mixed
Properties
options
Options for the GitHub object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Http\Http
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
comments
GitHub API object for comments.
Type(s)
\Joomla\Github\Package\Pulls\Comments