Gists
Extends AbstractPackageGitHub API Gists class for the Joomla Framework.
| link | |
|---|---|
| since |
1.0 |
| property-read Comments |
GitHub API object for gist 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\RegistryGitHub options object.- client
\Joomla\Http\HttpThe 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
stringName of property to retrieve
Response
\Joomla\Github\AbstractPackageGitHub API package object.
buildFileData
Method to fetch a data array for transmitting to the GitHub API for a list of files based on an input array of file paths or filename and content pairs.
buildFileData(array files) : array
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- files
arrayThe list of file paths or filenames and content.
Response
array
create
Create a gist.
create(mixed files, bool public = false, string description = null) : object
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- files
mixedEither an array of file paths or a single file path as a string.- public
boolTrue if the gist should be public.- description
stringThe optional description of the gist.
Response
object
delete
Delete a gist.
delete(int gistId) : void
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
edit
Edit a gist.
edit(int gistId, mixed files = null, bool public = null, string description = null) : object
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.- files
mixedEither an array of file paths or a single file path as a string.- public
boolTrue if the gist should be public.- description
stringThe description of the gist.
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
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
\Joomla\Uri\Uri
fork
Fork a gist.
fork(int gistId) : object
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
object
get
Get a single gist.
get(int gistId) : object
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
object
getCommitList
List gist commits.
getCommitList(int gistId, int page, int limit) : array
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
array
getForkList
List gist forks.
getForkList(int gistId, int page, int limit) : array
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
array
getList
List gists.
getList(int page, int limit) : array
If a user is authenticated it will return the user's gists, otherwise it will return all public gists.
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
array
getListByUser
List a user’s gists.
getListByUser(string user, int page, int limit, \DateTime since = null) : array
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the GitHub user from which to list gists.- page
intThe page number from which to get items.- limit
intThe number of items on a page.- since
\DateTimeOnly gists updated at or after this time are returned.
Response
array
getListPublic
List all public gists.
getListPublic(int page, int limit, \DateTime since = null) : array
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- page
intThe page number from which to get items.- limit
intThe number of items on a page.- since
\DateTimeOnly gists updated at or after this time are returned.
Response
array
getListStarred
List starred gists.
getListStarred(int page, int limit, \DateTime since = null) : array
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- page
intThe page number from which to get items.- limit
intThe number of items on a page.- since
\DateTimeOnly gists updated at or after this time are returned.
Response
array
getRevision
Get a specific revision of a gist.
getRevision(int gistId, string sha) : object
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.- sha
stringThe SHA for the revision to get.
Response
object
isStarred
Check if a gist is starred.
isStarred(int gistId) : bool
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
boolTrue if gist is starred
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
\Joomla\Http\ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
star
Star a gist.
star(int gistId) : void
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
unstar
Unstar a gist.
unstar(int gistId) : void
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
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 gist comments.
Type(s)
\Joomla\Github\Package\Gists\Comments