Commits
Extends AbstractPackageGitHub API Repositories Commits class for the Joomla Framework.
link | |
---|---|
since |
1.0 |
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.
compare
Compare two commits.
compare(string user, string repo, string base, string head) : object
since |
1.0 |
---|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- base
string
The base of the diff, either a commit SHA or branch.- head
string
The head of the diff, either a commit SHA or branch.
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 commit.
get(string user, string repo, string sha) : 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.- sha
string
The SHA of the commit to retrieve.
Response
object
getList
List commits on a repository.
getList(string user, string repo, string sha = '', string path = '', string author = '', \DateTimeInterface since = null, \DateTimeInterface until = null) : object
A special note on pagination: Due to the way Git works, commits are paginated based on SHA instead of page number. Please follow the link headers as outlined in the pagination overview instead of constructing page links yourself.
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- sha
string
Sha or branch to start listing commits from.- path
string
Only commits containing this file path will be returned.- author
string
GitHub login, name, or email by which to filter by commit author.- since
\DateTimeInterface
ISO 8601 Date - Only commits after this date will be returned.- until
\DateTimeInterface
ISO 8601 Date - Only commits before this date will be returned.
Response
object
getSha
Get the SHA-1 of a commit reference.
getSha(string user, string repo, string ref) : string
since |
1.4.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- ref
string
The commit reference
Response
string
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