Skip to content

Latest commit

 

History

History
151 lines (111 loc) · 10 KB

usage.md

File metadata and controls

151 lines (111 loc) · 10 KB

Table of contents

Class: \MultiHttp\Http (abstract)

Class Http

Visibility Function
public abstract delete(mixed $uri, array $options=array()) : mixed
public abstract get(mixed $uri, array $options=array()) : mixed
public abstract head(mixed $uri, array $options=array()) : mixed
public abstract options(mixed $uri, array $options=array()) : mixed
public abstract patch(mixed $uri, null $payload=null, array $options=array()) : mixed
public abstract post(mixed $uri, null $payload=null, array $options=array()) : mixed
public abstract put(mixed $uri, null $payload=null, array $options=array()) : mixed
public abstract trace(mixed $uri, array $options=array()) : mixed

Class: \MultiHttp\Mime

Class to organize the Mime stuff a bit more

Visibility Function
public static getFullMime(string $short_name) : string full mime type (e.g. application/json)
Get the full Mime Type name from a "short name". Returns the short if no mapping was found.
public static supportsMimeType(string $short_name) : bool

Class: \MultiHttp\MultiRequest

Visibility Function
public add(mixed $method, mixed $uri, mixed $payload, array $options=array()) : \MultiHttp$this
public addOptions(array $URLOptions) : \MultiHttp$this
example: array(array('url'=>'http://localhost:9999/','timeout'=>1, 'method'=>'POST', 'data'=>'aa=bb&c=d'))
public static create() : \MultiHttp\MultiRequest
public import(\MultiHttp\Request $request) : \MultiHttp$this
public sendAll() : \MultiHttp\array(Response)
public setDefaults(array $options=array()) : \MultiHttp$this
protected __construct() : void
MultiRequest constructor.
protected static prepare() : void

Class: \MultiHttp\Request

Class Request

Visibility Function
public addHeader(mixed $headerName, mixed $value) : \MultiHttp$this
public addHeaders(array $headers) : \MultiHttp$this
public addOptions(array $options=array()) : \MultiHttp$this
public addQuery(mixed $data) : \MultiHttp$this
public applyOptions() : \MultiHttp$this
public static create() : \MultiHttp\Request
public delete(mixed $uri, array $options=array()) : \MultiHttp\Request
public endCallback() : mixed
public expectsMime(string $mime='json') : \MultiHttp$this
public get(mixed $uri, array $options=array()) : \MultiHttp\Request
public getIni(mixed $field=null) : bool/mixed
public hasEndCallback() : bool
public head(mixed $uri, array $options=array()) : \MultiHttp\Request
public json(mixed $body) : string
public makeResponse(bool $isMultiCurl=false) : \MultiHttp\Response
public onEnd(\callable $callback) : \MultiHttp$this
public options(mixed $uri, array $options=array()) : \MultiHttp\Request
public patch(mixed $uri, null $payload=null, array $options=array()) : \MultiHttp\Request
public post(mixed $uri, null $payload=null, array $options=array()) : \MultiHttp\Request
public put(mixed $uri, null $payload=null, array $options=array()) : \MultiHttp\Request
public send(bool $isMultiCurl=false) : \MultiHttp\Response
public sendMime(string $mime='json') : \MultiHttp\Request
public serializeBody() : void
public static setLogHandler(\callable $handler) : void
public timeout(mixed $timeout) : \MultiHttp$this
public trace(mixed $uri, array $options=array()) : \MultiHttp\Request
public unJson(mixed $body) : mixed
public uri(mixed $uri) : \MultiHttp$this
protected __construct() : void
Request constructor.
protected static filterAndRaw(array $options) : array
protected static fullOption(mixed $key) : mixed
protected ini(mixed $method, mixed $url, mixed $data, array $options=array()) : \MultiHttp$this
protected prepare() : \MultiHttp$this

This class extends \MultiHttp\Http

Class: \MultiHttp\Response

Class Response

Visibility Function
public static create(\MultiHttp\Request $request, mixed $body, mixed $info, mixed $errorCode, mixed $error) : \MultiHttp\Response
public hasErrors() : bool Did we receive a 4xx or 5xx?
Status Code Definitions Informational 1xx Successful 2xx Redirection 3xx Client Error 4xx Server Error 5xx http://pretty-rfc.herokuapp.com/RFC2616#status.codes
public parse() : void
public unserializeBody() : void
protected __construct() : void
Response constructor.

Class: \MultiHttp\Exception\InvalidArgumentException

Class InvalidArgumentException

Visibility Function

This class extends \LogicException

This class implements \Throwable

Class: \MultiHttp\Exception\InvalidOperationException

Class InvalidOperationException

Visibility Function

This class extends \LogicException

This class implements \Throwable

Class: \MultiHttp\Exception\UnexpectedResponseException

Class UnexpectedResponseException

Visibility Function

This class extends \UnexpectedValueException

This class implements \Throwable