JGithubPackageRepositoriesCommits
Extends \JGithubPackageGitHub API Repositories Commits 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\Registry
GitHub options object.- $client
\JGithubHttp
The HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
since |
3.3 |
---|---|
throws |
|
Arguments
- $name
string
Name of property to retrieve
Response
\JGithubPackage
GitHub API package object.
compare
Method to get a diff for two commits.
compare(string $user, string $repo, string $base, string $head) : array
since |
3.0.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
array
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
string
URL to inflect- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
string
The request URL.
get
Method to get a single commit for a repository.
get(string $user, string $repo, string $sha) : array
throws |
|
---|---|
since |
3.0.0 |
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
array
getList
Method to list commits for a repository.
getList(string $user, string $repo, string $sha = '', string $path = '', string $author = '', \JDate $since = null, \JDate $until = null) : array
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.
throws |
|
---|---|
since |
3.0.0 |
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
\JDate
ISO 8601 Date - Only commits after this date will be returned.- $until
\JDate
ISO 8601 Date - Only commits before this date will be returned.
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
\JHttpResponse
The response.- $expectedCode
integer
The expected "good" code.- $decode
boolean
If 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.