\JGithubPulls

GitHub API Pull Requests class for the Joomla Platform.

Synopsis

class JGithubPulls extends JGithubObject {

• // Inherited members from JGithubObject
• protected JRegistry  $options;
• protected JGithubHttp  $client;
• // methods
• public  create()
• public  createComment()
• public  createCommentReply()
• public  createFromIssue()
• public void deleteComment()
• public  edit()
• public  editComment()
• public  get()
• public  getComment()
• public array getComments()
• public array getCommits()
• public array getFiles()
• public array getList()
• public boolean isMerged()
• public  merge()
• // 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 pull request.
• createComment() — Method to create a comment on a pull request.
• createCommentReply() — Method to create a comment in reply to another comment.
• createFromIssue() — Method to create a pull request from an existing issue.
• deleteComment() — Method to delete a comment on a pull request.
• edit() — Method to update a pull request.
• editComment() — Method to update a comment on a pull request.
• get() — Method to get a single pull request.
• getComment() — Method to get a specific comment on a pull request.
• getComments() — Method to get the list of comments on a pull request.
• getCommits() — Method to get a list of commits for a pull request.
• getFiles() — Method to get a list of files for a pull request.
• getList() — Method to list pull requests.
• isMerged() — Method to check if a pull request has been merged.
• merge() — Method to merge a pull request.

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.