Properties

$url

$url : string

URL

Type

string

$method

$method : string

Method

Type

string

$resource

$resource : resource

Client resource object

Type

resource

$options

$options : array

cURL options

Type

array

Methods

__construct()

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

Constructor

Instantiate the cURL object

Parameters

string $url
string $method
array $opts

Throws

\Pop\Http\Client\Exception

getUrl()

getUrl() : string

Get the URL

Returns

string

setMethod()

setMethod(string  $method, boolean  $strict = true) : \Pop\Http\Client\Curl

Set the method

Parameters

string $method
boolean $strict

Throws

\Pop\Http\Client\Exception

Returns

\Pop\Http\Client\Curl

getMethod()

getMethod() : string

Get the method

Returns

string

hasResource()

hasResource() : boolean

Determine whether or not resource is available

Returns

boolean

getResource()

getResource() : resource

Get the resource

Returns

resource

resource()

resource() : resource

Get the resource (alias method)

Returns

resource

hasRequest()

hasRequest() : boolean

Has request object

Returns

boolean

hasResponse()

hasResponse() : boolean

Has response object

Returns

boolean

getParsedResponse()

getParsedResponse() : mixed

Get the parsed response

Returns

mixed

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

addRequestHeaders()

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

Add request headers

Parameters

array $headers

Returns

\Pop\Http\Client\AbstractClient

addRequestHeader()

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

Add request header

Parameters

string $name
string $value

Returns

\Pop\Http\Client\AbstractClient

hasRequestHeaders()

hasRequestHeaders() : boolean

Has request headers

Returns

boolean

hasRequestHeader()

hasRequestHeader(string  $name) : boolean

Has request header

Parameters

string $name

Returns

boolean

getRequestHeaders()

getRequestHeaders() : array

Get the request headers

Returns

array

getRequestHeader()

getRequestHeader(string  $name) : mixed

Get the request header

Parameters

string $name

Returns

mixed

getRequestBody()

getRequestBody() : string

Get the request body

Returns

string

isJson()

isJson() : boolean

Check if request is JSON

Returns

boolean

createUrlEncodedForm()

createUrlEncodedForm() : \Pop\Http\Client\AbstractClient

Create request as a URL-encoded form

Returns

\Pop\Http\Client\AbstractClient

isUrlEncodedForm()

isUrlEncodedForm() : boolean

Check if request is a URL-encoded form

Returns

boolean

isMultipartForm()

isMultipartForm() : boolean

Check if request is a multipart form

Returns

boolean

addResponseHeaders()

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

Add response headers

Parameters

array $headers

Returns

\Pop\Http\Client\AbstractClient

addResponseHeader()

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

Add response header

Parameters

string $name
string $value

Returns

\Pop\Http\Client\AbstractClient

hasResponseHeaders()

hasResponseHeaders() : boolean

Has response headers

Returns

boolean

hasResponseHeader()

hasResponseHeader(string  $name) : boolean

Has response header

Parameters

string $name

Returns

boolean

getResponseHeaders()

getResponseHeaders() : array

Get the response headers

Returns

array

getResponseHeader()

getResponseHeader(string  $name) : mixed

Get the response header

Parameters

string $name

Returns

mixed

getResponseBody()

getResponseBody() : string

Get the response body

Returns

string

getResponseCode()

getResponseCode() : string

Get the response code

Returns

string

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

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

hasOption()

hasOption(integer  $opt) : boolean

Has a cURL session option

Parameters

integer $opt

Returns

boolean

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