PHP Класс Milo\Github\Api

См. также: https://developer.github.com/v3/
Автор: Miloslav Hůla (https://github.com/milo)
Наследование: extends Milo\Github\Sanity
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( Milo\Github\Http\IClient $client = NULL )
createRequest ( $method, $urlPath, array $parameters = [], array $headers = [], $content = NULL ) : Milo\Github\Http\Request
decode ( Milo\Github\Http\Response $response, array $okCodes = NULL ) : mixed
delete ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
get ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
getClient ( ) : Milo\Github\Http\IClient
getDefaultParameters ( ) : array
getToken ( ) : Milo\Github\OAuth\Token | null
getUrl ( ) : string
head ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
paginator ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Paginator Creates paginator for HTTP GET requests.
patch ( $urlPath, $content, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
post ( $urlPath, $content, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
put ( $urlPath, $content = NULL, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
request ( Milo\Github\Http\Request $request ) : Milo\Github\Http\Response
setDefaultParameters ( array $defaults = NULL ) : self
setToken ( Milo\Github\OAuth\Token $token = NULL ) : self
setUrl ( $url ) : self
withUrl ( $url ) : Api

Защищенные методы

Метод Описание
expandColonParameters ( $url, array $parameters, array $defaultParameters ) : string
expandUriTemplate ( $url, array $parameters, array $defaultParameters ) : string Expands URI template (RFC 6570).

Приватные методы

Метод Описание
errorMessage ( $content ) : string
escape ( array $flags, $value, $maxLength = NULL ) : string
prefix ( array $flags, $name, $value ) : string
walk ( array $array, $cb )

Описание методов

__construct() публичный Метод

public __construct ( Milo\Github\Http\IClient $client = NULL )
$client Milo\Github\Http\IClient

createRequest() публичный Метод

public createRequest ( $method, $urlPath, array $parameters = [], array $headers = [], $content = NULL ) : Milo\Github\Http\Request
$parameters array
$headers array
Результат Milo\Github\Http\Request

decode() публичный Метод

public decode ( Milo\Github\Http\Response $response, array $okCodes = NULL ) : mixed
$response Milo\Github\Http\Response
$okCodes array
Результат mixed

delete() публичный Метод

См. также: createRequest()
См. также: request()
public delete ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
$parameters array
$headers array
Результат Milo\Github\Http\Response

expandColonParameters() защищенный Метод

protected expandColonParameters ( $url, array $parameters, array $defaultParameters ) : string
$parameters array
$defaultParameters array
Результат string

expandUriTemplate() защищенный Метод

Expands URI template (RFC 6570).
См. также: http://tools.ietf.org/html/rfc6570
protected expandUriTemplate ( $url, array $parameters, array $defaultParameters ) : string
$parameters array
$defaultParameters array
Результат string

get() публичный Метод

См. также: createRequest()
См. также: request()
public get ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
$parameters array
$headers array
Результат Milo\Github\Http\Response

getClient() публичный Метод

public getClient ( ) : Milo\Github\Http\IClient
Результат Milo\Github\Http\IClient

getDefaultParameters() публичный Метод

public getDefaultParameters ( ) : array
Результат array

getToken() публичный Метод

public getToken ( ) : Milo\Github\OAuth\Token | null
Результат Milo\Github\OAuth\Token | null

getUrl() публичный Метод

public getUrl ( ) : string
Результат string

head() публичный Метод

См. также: createRequest()
См. также: request()
public head ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
$parameters array
$headers array
Результат Milo\Github\Http\Response

paginator() публичный Метод

Creates paginator for HTTP GET requests.
См. также: get()
public paginator ( $urlPath, array $parameters = [], array $headers = [] ) : Milo\Github\Paginator
$parameters array
$headers array
Результат Milo\Github\Paginator

patch() публичный Метод

См. также: createRequest()
См. также: request()
public patch ( $urlPath, $content, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
$parameters array
$headers array
Результат Milo\Github\Http\Response

post() публичный Метод

См. также: createRequest()
См. также: request()
public post ( $urlPath, $content, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
$parameters array
$headers array
Результат Milo\Github\Http\Response

put() публичный Метод

См. также: createRequest()
См. также: request()
public put ( $urlPath, $content = NULL, array $parameters = [], array $headers = [] ) : Milo\Github\Http\Response
$parameters array
$headers array
Результат Milo\Github\Http\Response

request() публичный Метод

public request ( Milo\Github\Http\Request $request ) : Milo\Github\Http\Response
$request Milo\Github\Http\Request
Результат Milo\Github\Http\Response

setDefaultParameters() публичный Метод

public setDefaultParameters ( array $defaults = NULL ) : self
$defaults array
Результат self

setToken() публичный Метод

public setToken ( Milo\Github\OAuth\Token $token = NULL ) : self
$token Milo\Github\OAuth\Token
Результат self

setUrl() публичный Метод

public setUrl ( $url ) : self
Результат self

withUrl() публичный Метод

public withUrl ( $url ) : Api
Результат Api