Docs For Class JGithubGists

JGithubGists

Description

GitHub API Gists class for the Joomla Platform.

since: 11.3

Located in /libraries/joomla/github/gists.php (line 19)

JGithubObject
   |
   --JGithubGists

Method Summary

array buildFileData (array $files)

object create (mixed $files, [boolean $public = false], [string $description = null])

object createComment (integer $gistId, string $body)

void delete (integer $gistId)

void deleteComment (integer $commentId)

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

object editComment (integer $commentId, string $body)

object fork (integer $gistId)

object get (integer $gistId)

object getComment (integer $commentId)

array getComments (integer $gistId, [integer $page = 0], [integer $limit = 0])

array getList ([integer $page = 0], [integer $limit = 0])

array getListByUser (string $user, [integer $page = 0], [integer $limit = 0])

array getListPublic ([integer $page = 0], [integer $limit = 0])

array getListStarred ([integer $page = 0], [integer $limit = 0])

boolean isStarred (integer $gistId)

void star (integer $gistId)

void unstar (integer $gistId)

Variables

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
JGithubObject::$options

Methods

buildFileData (line 568)

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.

since: 11.3
access: protected

array buildFileData (array $files)

array $files: The list of file paths or filenames and content.

create (line 32)

Method to create a gist.

since: 11.3
access: public

object create (mixed $files, [boolean $public = false], [string $description = null])

mixed $files: Either an array of file paths or a single file path as a string.
boolean $public: True if the gist should be public.
string $description: The optional description of the gist.

createComment (line 70)

Method to create a comment on a gist.

since: 11.3
access: public

object createComment (integer $gistId, string $body)

integer $gistId: The gist number.
string $body: The comment body text.

delete (line 105)

Method to delete a gist.

since: 11.3
access: public

void delete (integer $gistId)

integer $gistId: The gist number.

deleteComment (line 131)

Method to delete a comment on a gist.

since: 11.3
access: public

void deleteComment (integer $commentId)

integer $commentId: The id of the comment to delete.

edit (line 160)

Method to update a gist.

since: 11.3
access: public

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

integer $gistId: The gist number.
mixed $files: Either an array of file paths or a single file path as a string.
boolean $public: True if the gist should be public.
string $description: The description of the gist.

editComment (line 213)

Method to update a comment on a gist.

since: 11.3
access: public

object editComment (integer $commentId, string $body)

integer $commentId: The id of the comment to update.
string $body: The new body text for the comment.

fork (line 248)

Method to fork a gist.

since: 11.3
access: public

object fork (integer $gistId)

integer $gistId: The gist number.

get (line 277)

Method to get a single gist.

since: 11.3
access: public

object get (integer $gistId)

integer $gistId: The gist number.

getComment (line 305)

Method to get a specific comment on a gist.

since: 11.3
access: public

object getComment (integer $commentId)

integer $commentId: The comment id to get.

getComments (line 335)

Method to get the list of comments on a gist.

since: 11.3
access: public

array getComments (integer $gistId, [integer $page = 0], [integer $limit = 0])

integer $gistId: The gist number.
integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

getList (line 365)

Method to list gists. If a user is authenticated it will return the user's gists, otherwise it will return all public gists.

since: 11.3
access: public

array getList ([integer $page = 0], [integer $limit = 0])

integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

getListByUser (line 395)

Method to get a list of gists belonging to a given user.

since: 11.3
access: public

array getListByUser (string $user, [integer $page = 0], [integer $limit = 0])

string $user: The name of the GitHub user from which to list gists.
integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

getListPublic (line 424)

Method to get a list of all public gists.

since: 11.3
access: public

array getListPublic ([integer $page = 0], [integer $limit = 0])

integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

getListStarred (line 453)

Method to get a list of the authenticated users' starred gists.

since: 11.3
access: public

array getListStarred ([integer $page = 0], [integer $limit = 0])

integer $page: The page number from which to get items.
integer $limit: The number of items on a page.

isStarred (line 481)

Method to check if a gist has been starred.

return: True if the gist is starred.
since: 11.3
access: public

boolean isStarred (integer $gistId)

integer $gistId: The gist number.

star (line 515)

Method to star a gist.

since: 11.3
access: public

void star (integer $gistId)

integer $gistId: The gist number.

unstar (line 541)

Method to star a gist.

since: 11.3
access: public

void unstar (integer $gistId)

integer $gistId: The gist number.

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()

Documentation generated on Tue, 19 Nov 2013 15:03:59 +0100 by phpDocumentor 1.4.3