Pulls

Extends \Joomla\Github\AbstractPackage

GitHub API Pull Requests class for the Joomla Framework.

link

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

since

1.0

property-read

GitHub API object for 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.

create

Create a pull request.

create(string $user, string $repo, string $title, string $base, string $head, string $body = '') : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$title

stringThe title of the new pull request.

$base

stringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.

$head

stringThe branch (or git ref) where your changes are implemented.

$body

stringThe body text for the new pull request.

Response

object

createFromIssue

Method to create a pull request from an existing issue.

createFromIssue(string $user, string $repo, integer $issueId, string $base, string $head) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$issueId

integerThe issue number for which to attach the new pull request.

$base

stringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.

$head

stringThe branch (or git ref) where your changes are implemented.

Response

object

edit

Update a pull request.

edit(string $user, string $repo, integer $pullId, string $title = null, string $body = null, string $state = null, string $base = null) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$title

stringThe optional new title for the pull request.

$body

stringThe optional new body text for the pull request.

$state

stringThe optional new state for the pull request. [open, closed]

$base

stringThe optional new base branch for the pull request.

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.

get

Get a single pull request.

get(string $user, string $repo, integer $pullId) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

Response

object

getCommits

List commits on a pull request.

getCommits(string $user, string $repo, integer $pullId, integer $page, integer $limit) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

object

getFiles

List pull requests files.

getFiles(string $user, string $repo, integer $pullId, integer $page, integer $limit) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

object

getList

List pull requests.

getList(string $user, string $repo, string $state = 'open', integer $page, integer $limit) : array
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$state

stringThe optional state to filter requests by. [open, closed]

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

array

isMerged

Get if a pull request has been merged.

isMerged(string $user, string $repo, integer $pullId) : boolean
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number. The pull request number.

Response

booleanTrue if the pull request has been merged

merge

Merge a pull request (Merge Button).

merge(string $user, string $repo, integer $pullId, string $message = '') : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$message

stringThe message that will be used for the merge commit.

Response

object

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

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

Type(s)

\Joomla\Github\Package\Pulls\Comments