\JGithubCommits

GitHub API Commits class for the Joomla Platform.

Synopsis

class JGithubCommits extends JGithubObject {

• // Inherited members from JGithubObject
• protected JRegistry  $options;
• protected JGithubHttp  $client;
• // methods
• public  create()
• public  createCommitComment()
• public  deleteCommitComment()
• public  editCommitComment()
• public array getCommit()
• public array getCommitComment()
• public array getCommitComments()
• public array getDiff()
• public array getList()
• public array getListComments()
• // Inherited methods from JGithubObject
• public void __construct()
• protected string fetchUrl()
• protected mixed processResponse()
}


Hierarchy

Extends

• JGithubObject

Members

protected

• $client — JGithubHttp
• $options — JRegistry

Methods

public

• create() — Method to create a commit.
• createCommitComment() — Method to create a comment on a commit.
• deleteCommitComment() — Method to delete a comment on a commit.
• editCommitComment() — Method to edit a comment on a commit.
• getCommit() — Method to get a single commit for a repository.
• getCommitComment() — Method to get a single comment on a commit.
• getCommitComments() — Method to get a list of comments for a single commit for a repository.
• getDiff() — Method to get a diff for two commits.
• getList() — Method to list commits for a repository.
• getListComments() — Method to get a list of commit comments for a repository.

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.