Gists

Extends \Joomla\Github\AbstractPackage

GitHub API Gists class for the Joomla Framework.

link

https://developer.github.com/v3/gists

since

1.0

property-read

GitHub API object for gist comments.

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \Joomla\Http\Http $client = null) 
inherited
since

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \Joomla\Github\AbstractPackage
inherited
since

1.0

throws

\InvalidArgumentException

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

\InvalidArgumentException

Arguments

$files

arrayThe list of file paths or filenames and content.

Response

array

create

Create a gist.

create(mixed $files, boolean $public = false, string $description = null) : object
since

1.0

throws

\DomainException

Arguments

$files

mixedEither an array of file paths or a single file path as a string.

$public

booleanTrue if the gist should be public.

$description

stringThe optional description of the gist.

Response

object

delete

Delete a gist.

delete(integer $gistId) : void
since

1.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

edit

Edit a gist.

edit(integer $gistId, mixed $files = null, boolean $public = null, string $description = null) : object
since

1.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

$files

mixedEither an array of file paths or a single file path as a string.

$public

booleanTrue 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, integer $page, integer $limit) : string
inherited
since

1.0

note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

fork

Fork a gist.

fork(integer $gistId) : object
since

1.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

Response

object

get

Get a single gist.

get(integer $gistId) : object
since

1.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

Response

object

getCommitList

List gist commits.

getCommitList(integer $gistId, integer $page, integer $limit) : array
since

1.4.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

array

getForkList

List gist forks.

getForkList(integer $gistId, integer $page, integer $limit) : array
since

1.4.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

array

getList

List gists.

getList(integer $page, integer $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

\DomainException

Arguments

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

array

getListByUser

List a user’s gists.

getListByUser(string $user, integer $page, integer $limit, \DateTime $since = null) : array
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the GitHub user from which to list gists.

$page

integerThe page number from which to get items.

$limit

integerThe 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(integer $page, integer $limit, \DateTime $since = null) : array
since

1.0

throws

\DomainException

Arguments

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

$since

\DateTimeOnly gists updated at or after this time are returned.

Response

array

getListStarred

List starred gists.

getListStarred(integer $page, integer $limit, \DateTime $since = null) : array
since

1.0

throws

\DomainException

Arguments

$page

integerThe page number from which to get items.

$limit

integerThe 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(integer $gistId, string $sha) : object
since

1.4.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

$sha

stringThe SHA for the revision to get.

Response

object

isStarred

Check if a gist is starred.

isStarred(integer $gistId) : boolean
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$gistId

integerThe gist number.

Response

booleanTrue if gist is starred

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response $response, integer $expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe expected "good" code.

Response

mixed

star

Star a gist.

star(integer $gistId) : void
since

1.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

unstar

Unstar a gist.

unstar(integer $gistId) : void
since

1.0

throws

\DomainException

Arguments

$gistId

integerThe gist number.

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Github\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2

link

https://developer.github.com/webhooks/#events

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