\duncan3dc\GitHubRepositoryInterface

Summary

Methods
Constants
request()
post()
put()
delete()
get()
getAll()
getName()
getFullName()
getDescription()
isPrivate()
isPublic()
isFork()
getBranches()
getBranch()
getDefaultBranch()
getPullRequest()
getTags()
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>

getName()

getName() : string

Get the name of this repository.

Returns

string

getFullName()

getFullName() : string

Get the full name of this repository (including the owner).

Returns

string

getDescription()

getDescription() : string

Get the description of this repository.

Returns

string

isPrivate()

isPrivate() : boolean

Check if this repository is private.

Returns

boolean

isPublic()

isPublic() : boolean

Check if this repository is public.

Returns

boolean

isFork()

isFork() : boolean

Check if this repository is a fork of another.

Returns

boolean

getBranches()

getBranches() : \duncan3dc\GitHub\iterable|array<mixed,\duncan3dc\GitHub\BranchInterface>

Get all the branches in this repository.

Returns

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

getBranch()

getBranch(string  $branch) : \duncan3dc\GitHub\BranchInterface

Get a branch from this repository.

Parameters

string $branch

The name of the branch

Returns

\duncan3dc\GitHub\BranchInterface

getPullRequest()

getPullRequest(integer  $number) : \duncan3dc\GitHub\PullRequestInterface

Get a pull request from this repository.

Parameters

integer $number

The unique ID of the pr

Returns

\duncan3dc\GitHub\PullRequestInterface

getTags()

getTags() : \duncan3dc\GitHub\iterable|array<mixed,\duncan3dc\GitHub\TagInterface>

Get all the tags in this repository.

Returns

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