Properties

$resource

$resource : resource

Client resource object

Type

resource

$url

$url : string

URL

Type

string

$method

$method : string

Method

Type

string

$fields

$fields : array

Fields

Type

array

$query

$query : string

Query

Type

string

$requestHeaders

$requestHeaders : array

Request headers

Type

array

$version

$version : string

HTTP version from response

Type

string

$code

$code : integer

Response code

Type

integer

$message

$message : string

Response message

Type

string

$response

$response : string

Raw response string

Type

string

$responseHeader

$responseHeader : string

Raw response header

Type

string

$responseHeaders

$responseHeaders : array

Response headers

Type

array

$body

$body : string

Response body

Type

string

$options

$options : array

cURL options

Type

array

Methods

getUrl()

getUrl() : string

Get the URL

Returns

string

setMethod()

setMethod(string  $method) : \Pop\Http\Client\Curl

Set the method

Parameters

string $method

Throws

\Pop\Http\Client\Exception

Returns

\Pop\Http\Client\Curl

getMethod()

getMethod() : string

Get the method

Returns

string

setField()

setField(string  $name, mixed  $value) : \Pop\Http\Client\AbstractClient

Set a field

Parameters

string $name
mixed $value

Returns

\Pop\Http\Client\AbstractClient

getField()

getField(string  $name) : mixed

Get a field

Parameters

string $name

Returns

mixed

getFields()

getFields() : array

Get all field

Returns

array

prepareQuery()

prepareQuery() : string

Prepare the HTTP query

Returns

string

getQuery()

getQuery() : string

Get HTTP query

Returns

string

getQueryLength()

getQueryLength(boolean  $mb = true) : integer

Get HTTP query length

Parameters

boolean $mb

Returns

integer

setRequestHeader()

setRequestHeader(string  $name, string  $value) : \Pop\Http\Client\AbstractClient

Set a request header

Parameters

string $name
string $value

Returns

\Pop\Http\Client\AbstractClient

setRequestHeaders()

setRequestHeaders(array  $headers) : \Pop\Http\Client\AbstractClient

Set all request headers

Parameters

array $headers

Returns

\Pop\Http\Client\AbstractClient

getRequestHeader()

getRequestHeader(string  $name) : mixed

Get a request header

Parameters

string $name

Returns

mixed

getRequestHeaders()

getRequestHeaders() : array

Get all request headers

Returns

array

hasRequestHeaders()

hasRequestHeaders() : boolean

Determine if there are request headers

Returns

boolean

getResponseHeader()

getResponseHeader(string  $name) : mixed

Get a response header

Parameters

string $name

Returns

mixed

getResponseHeaders()

getResponseHeaders() : array

Get all response headers

Returns

array

hasResponseHeaders()

hasResponseHeaders() : boolean

Determine if there are response headers

Returns

boolean

getRawResponseHeader()

getRawResponseHeader() : string

Get raw response header

Returns

string

getBody()

getBody() : string

Get the response body

Returns

string

getCode()

getCode() : string

Get the response code

Returns

string

isSuccess()

isSuccess() : boolean

Determine if the response is a success

Returns

boolean

isRedirect()

isRedirect() : boolean

Determine if the response is a redirect

Returns

boolean

isError()

isError() : boolean

Determine if the response is an error

Returns

boolean

isClientError()

isClientError() : boolean

Determine if the response is a client error

Returns

boolean

isServerError()

isServerError() : boolean

Determine if the response is a server error

Returns

boolean

getHttpVersion()

getHttpVersion() : string

Get the response HTTP version

Returns

string

getMessage()

getMessage() : string

Get the response HTTP message

Returns

string

getResponse()

getResponse() : string

Get the raw response

Returns

string

hasResource()

hasResource() : boolean

Determine whether or not resource is available

Returns

boolean

getResource()

getResource() : resource

Get the resource

Returns

resource

decodeBody()

decodeBody() : void

Decode the body

throwError()

throwError(string  $error) : void

Throw an exception upon an error.

Parameters

string $error

Throws

\Pop\Http\Client\Exception

send()

send() : void

Method to send the request and get the response

__construct()

__construct(string  $url, string  $method = 'GET', array  $opts = null) 

Constructor

Instantiate the cURL object

Parameters

string $url
string $method
array $opts

Throws

\Pop\Http\Client\Exception

curl()

curl() : resource

Return cURL resource (alias to $this->getResource())

Returns

resource

setOption()

setOption(integer  $opt, mixed  $val) : \Pop\Http\Client\Curl

Set cURL session option

Parameters

integer $opt
mixed $val

Returns

\Pop\Http\Client\Curl

setOptions()

setOptions(array  $opts) : \Pop\Http\Client\Curl

Set cURL session options

Parameters

array $opts

Returns

\Pop\Http\Client\Curl

setReturnHeader()

setReturnHeader(boolean  $header = true) : \Pop\Http\Client\Curl

Set cURL option to return the header

Parameters

boolean $header

Returns

\Pop\Http\Client\Curl

setReturnTransfer()

setReturnTransfer(boolean  $transfer = true) : \Pop\Http\Client\Curl

Set cURL option to return the transfer

Parameters

boolean $transfer

Returns

\Pop\Http\Client\Curl

isReturnHeader()

isReturnHeader() : boolean

Check if cURL is set to return header

Returns

boolean

isReturnTransfer()

isReturnTransfer() : boolean

Check if cURL is set to return transfer

Returns

boolean

getOption()

getOption(integer  $opt) : string

Get a cURL session option

Parameters

integer $opt

Returns

string

getInfo()

getInfo(integer  $opt = null) : array|string

Return the cURL session last info

Parameters

integer $opt

Returns

array|string

version()

version() : array

Return the cURL version

Returns

array

disconnect()

disconnect() : void

Close the cURL connection

parseResponseHeaders()

parseResponseHeaders() : void

Parse headers