\duncan3dc\GitHubPullRequestInterface

Summary

Methods
Constants
request()
post()
put()
delete()
get()
getAll()
getRepository()
getNumber()
getFiles()
getComments()
withCommit()
getCommit()
addComment()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

request()

request(string  $method, string  $url, array  $data = array()) : \Psr\Http\Message\ResponseInterface

Send a request and return the response.

Parameters

string $method

The HTTP verb to use for the request

string $url

The url to issue the request to (https://api.github.com is optional)

array $data

The parameters to send with the request

Returns

\Psr\Http\Message\ResponseInterface

post()

post(string  $url, array  $data = array()) : \stdClass

Send a POST request and return the response.

Parameters

string $url

The url to issue the request to (https://api.github.com is optional)

array $data

The parameters to send with the request

Returns

\stdClass

put()

put(string  $url, array  $data = array()) : \stdClass

Send a PUT request and return the response.

Parameters

string $url

The url to issue the request to (https://api.github.com is optional)

array $data

The parameters to send with the request

Returns

\stdClass

delete()

delete(string  $url, array  $data = array()) : \stdClass

Send a DELETE request and return the response.

Parameters

string $url

The url to issue the request to (https://api.github.com is optional)

array $data

The parameters to send with the request

Returns

\stdClass

get()

get(string  $url, array  $data = array()) : \stdClass

Send a GET request and return the response.

Parameters

string $url

The url to issue the request to (https://api.github.com is optional)

array $data

The parameters to send with the request

Returns

\stdClass

getAll()

getAll(string  $url, array  $data = array(), callable  $callback = null) : \Traversable|array<mixed,\stdClass>

Send a GET request and return the response.

This method will loop through all the pages until one returns no results

Parameters

string $url

The url to issue the request to (https://api.github.com is optional)

array $data

The parameters to send with the request

callable $callback

An optional handler to yield items via

Returns

\Traversable|array<mixed,\stdClass>

getNumber()

getNumber() : integer

Get the number of this pr.

Returns

integer

getFiles()

getFiles() : \duncan3dc\GitHub\iterable|array<mixed,\stdClass>

Get all the files that are touched by this pr.

Returns

\duncan3dc\GitHub\iterable|array<mixed,\stdClass>

getComments()

getComments() : \duncan3dc\GitHub\iterable|array<mixed,\stdClass>

Get all the comments on this pr.

Returns

\duncan3dc\GitHub\iterable|array<mixed,\stdClass>

withCommit()

withCommit(string  $commit) : \duncan3dc\GitHub\PullRequestInterface

Set the version of this pr we are working with.

Parameters

string $commit

The full sha of the commit in the pr

Returns

\duncan3dc\GitHub\PullRequestInterface

getCommit()

getCommit() : string

Get the version of this pr we are working with.

Returns

string

addComment()

addComment(\duncan3dc\GitHub\string  $comment, \duncan3dc\GitHub\string  $path, \duncan3dc\GitHub\int  $position) : void

Add a comment to the pr.

Parameters

\duncan3dc\GitHub\string $comment
\duncan3dc\GitHub\string $path
\duncan3dc\GitHub\int $position