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) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
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(mixed||string|int files) : mixed||string|int
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- files
array<string|int, mixed>The list of file paths or filenames and content.
Response
array<string|int, mixed>
create
Create a gist.
create( files, public = false, description = null) :
| 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( gistId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
void
edit
Edit a gist.
edit( gistId, files = null, public = null, description = null) :
| 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( path, page, 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
fork
Fork a gist.
fork( gistId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
object
get
Get a single gist.
get( gistId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
object
getCommitList
List gist commits.
getCommitList( gistId, page, limit) : mixed||string|int
| 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<string|int, mixed>
getForkList
List gist forks.
getForkList( gistId, page, limit) : mixed||string|int
| 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<string|int, mixed>
getList
List gists.
getList( page, limit) : mixed||string|int
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<string|int, mixed>
getListByUser
List a user’s gists.
getListByUser( user, page, limit, \DateTime since = null) : mixed||string|int
| 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
DateTime|nullOnly gists updated at or after this time are returned.
Response
array<string|int, mixed>
getListPublic
List all public gists.
getListPublic( page, limit, \DateTime since = null) : mixed||string|int
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- page
intThe page number from which to get items.- limit
intThe number of items on a page.- since
DateTime|nullOnly gists updated at or after this time are returned.
Response
array<string|int, mixed>
getListStarred
List starred gists.
getListStarred( page, limit, \DateTime since = null) : mixed||string|int
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- page
intThe page number from which to get items.- limit
intThe number of items on a page.- since
DateTime|nullOnly gists updated at or after this time are returned.
Response
array<string|int, mixed>
getRevision
Get a specific revision of a gist.
getRevision( gistId, sha) :
| 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( gistId) :
| 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, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
star
Star a gist.
star( gistId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
void
unstar
Unstar a gist.
unstar( gistId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- gistId
intThe gist number.
Response
void
Properties
comments
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<string|int, mixed>