JGithubPackageRepositoriesContents
Extends \JGithubPackageGitHub API Repositories Contents class for the Joomla Platform.
These API methods let you retrieve the contents of files within a repository as Base64 encoded content. See media types for requesting raw or other formats.
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.
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
Get contents
get(string $owner, string $repo, string $path, string $ref = '') : object
This method returns the contents of any file or directory in a repository.
GET /repos/:owner/:repo/contents/:path
Parameters
path Optional string - The content path. ref Optional string - The String name of the Commit/Branch/Tag. Defaults to master.
Response
Status: 200 OK X-RateLimit-Limit: 5000 X-RateLimit-Remaining: 4999
{ "type": "file", "encoding": "base64", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" }, "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1" }
since |
3.3 |
---|
Arguments
- $owner
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $path
string
The content path.- $ref
string
The String name of the Commit/Branch/Tag. Defaults to master.
Response
object
getArchiveLink
Get archive link
getArchiveLink(string $owner, string $repo, string $archiveFormat = 'zipball', string $ref = '') : object
This method will return a 302 to a URL to download a tarball or zipball archive for a repository. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request.
Note: For private repositories, these links are temporary and expire quickly.
GET /repos/:owner/:repo/:archive_format/:ref
Parameters
archive_format Either tarball or zipball ref Optional string - valid Git reference, defaults to master
Response
Status: 302 Found Location: http://github.com/me/myprivate/tarball/master?SSO=thistokenexpires X-RateLimit-Limit: 5000 X-RateLimit-Remaining: 4999
To follow redirects with curl, use the -L switch:
curl -L https://api.github.com/repos/octokit/octokit.rb/tarball > octokit.tar.gz
throws |
|
---|---|
since |
3.3 |
Arguments
- $owner
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $archiveFormat
string
Either tarball or zipball.- $ref
string
The String name of the Commit/Branch/Tag. Defaults to master.
Response
object
getReadme
Get the README
getReadme(string $owner, string $repo, string $ref = '') : object
This method returns the preferred README for a repository.
GET /repos/:owner/:repo/readme
Parameters
ref Optional string - The String name of the Commit/Branch/Tag. Defaults to master.
Response
Status: 200 OK X-RateLimit-Limit: 5000 X-RateLimit-Remaining: 4999
{ "type": "file", "encoding": "base64", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" }, "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1" }
since |
3.3 |
---|
Arguments
- $owner
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $ref
string
The String name of the Commit/Branch/Tag. Defaults to master.
Response
object
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.