\JGithubGists

GitHub API Gists class for the Joomla Platform.

Synopsis

class JGithubGists extends JGithubObject {

• // Inherited members from JGithubObject
• protected JRegistry  $options;
• protected JGithubHttp  $client;
• // methods
• public  create()
• public  createComment()
• public void delete()
• public void deleteComment()
• public  edit()
• public  editComment()
• public  fork()
• public  get()
• public  getComment()
• public array getComments()
• public array getList()
• public array getListByUser()
• public array getListPublic()
• public array getListStarred()
• public boolean isStarred()
• public void star()
• public void unstar()
• protected array buildFileData()
• // Inherited methods from JGithubObject
• public void __construct()
• protected string fetchUrl()
• protected mixed processResponse()
}


Hierarchy

Extends

• JGithubObject

Tasks

Tasks

Line	Task
254	Verify change

Members

protected

• $client — JGithubHttp
• $options — JRegistry

Methods

protected

• 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.

public

• create() — Method to create a gist.
• createComment() — Method to create a comment on a gist.
• delete() — Method to delete a gist.
• deleteComment() — Method to delete a comment on a gist.
• edit() — Method to update a gist.
• editComment() — Method to update a comment on a gist.
• fork() — Method to fork a gist.
• get() — Method to get a single gist.
• getComment() — Method to get a specific comment on a gist.
• getComments() — Method to get the list of comments on a gist.
• getList() — Method to list gists. If a user is authenticated it will return the user's gists, otherwise it will return all public gists.
• getListByUser() — Method to get a list of gists belonging to a given user.
• getListPublic() — Method to get a list of all public gists.
• getListStarred() — Method to get a list of the authenticated users' starred gists.
• isStarred() — Method to check if a gist has been starred.
• star() — Method to star a gist.
• unstar() — Method to star a gist.

Inherited from JGithubObject

protected

• 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.
• processResponse() — Process the response and decode it.