Contents
Extends AbstractPackageGitHub API Repositories Contents class for the Joomla Framework.
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.
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.
create
Create a file.
create(string owner, string repo, string path, string message, string content, string branch = 'master', string authorName = '', string authorEmail = '', string committerName = '', string committerEmail = '') : object
This method creates a new file in a repository.
Optional Parameters The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user’s information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you’ll receive a 500 status code.
since |
1.0 |
---|---|
throws |
|
Arguments
- owner
string
The owner of the repository.- repo
string
The repository name.- path
string
The content path.- message
string
The commit message.- content
string
The new file content, Base64 encoded.- branch
string
The branch name. If not provided, uses the repository’s default branch (usually master).- authorName
string
The name of the author of the commit- authorEmail
string
The email of the author of the commit- committerName
string
The name of the committer of the commit- committerEmail
string
The email of the committer of the commit
Response
object
delete
Delete a file.
delete(string owner, string repo, string path, string message, string sha, string branch = 'master', string authorName = '', string authorEmail = '', string committerName = '', string committerEmail = '') : object
This method deletes a file in a repository.
since |
1.0 |
---|---|
throws |
|
Arguments
- owner
string
The owner of the repository.- repo
string
The repository name.- path
string
The content path.- message
string
The commit message.- sha
string
The blob SHA of the file being replaced.- branch
string
The branch name. If not provided, uses the repository’s default branch (usually master).- authorName
string
The name of the author of the commit- authorEmail
string
The email of the author of the commit- committerName
string
The name of the committer of the commit- committerEmail
string
The email of the committer of the commit
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 contents.
get(string owner, string repo, string path, string ref = '') : object
This method returns the contents of any file or directory in a repository.
since |
1.0 |
---|
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.
To follow redirects with curl, use the -L switch: curl -L https://api.github.com/repos/pengwynn/octokit/tarball > octokit.tar.gz
since |
1.0 |
---|---|
throws |
|
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.
since |
1.0 |
---|---|
throws |
|
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(\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
update
Update a file.
update(string owner, string repo, string path, string message, string content, string sha, string branch = 'master', string authorName = '', string authorEmail = '', string committerName = '', string committerEmail = '') : object
This method updates a file in a repository.
Optional Parameters The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user’s information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you’ll receive a 500 status code.
since |
1.0 |
---|---|
throws |
|
Arguments
- owner
string
The owner of the repository.- repo
string
The repository name.- path
string
The content path.- message
string
The commit message.- content
string
The new file content, Base64 encoded.- sha
string
The blob SHA of the file being replaced.- branch
string
The branch name. If not provided, uses the repository’s default branch (usually master).- authorName
string
The name of the author of the commit- authorEmail
string
The email of the author of the commit- committerName
string
The name of the committer of the commit- committerEmail
string
The email of the committer of the commit
Response
object
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