\duncan3dc\GitHubOrganizationInterface

Summary

Methods
Constants
request()
post()
put()
delete()
get()
getAll()
getName()
getRepositories()
getRepository()
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 organization.

Returns

string

getRepositories()

getRepositories() : array<mixed,\duncan3dc\GitHub\RepositoryInterface>

Get all of the repositories for this installation.

Returns

array<mixed,\duncan3dc\GitHub\RepositoryInterface>

getRepository()

getRepository(string  $name) : \duncan3dc\GitHub\RepositoryInterface

Get a repository instance.

Parameters

string $name

The name of the repository

Returns

\duncan3dc\GitHub\RepositoryInterface