\Pop\Http\ClientCurl

__construct()

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

Constructor

Instantiate the cURL object

Parameters

Throws

\Pop\Http\Client\Exception

setUrl()

setUrl(string  $url) : \Pop\Http\Client\AbstractClient

Set the URL

Parameters

Returns

getUrl()

getUrl() : string

Get the URL

Returns

setMethod()

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

Set the method

Parameters

Throws

\Pop\Http\Client\Exception

Returns

getMethod()

getMethod() : string

Get the method

Returns

hasResource()

hasResource() : boolean

Determine whether or not resource is available

Returns

getResource()

getResource() : resource

Get the resource

Returns

resource()

resource() : resource

Get the resource (alias method)

Returns

setRequest()

setRequest(\Pop\Http\Client\Request  $request) : \Pop\Http\Client\AbstractClient

Set the request object

Parameters

Returns

hasRequest()

hasRequest() : boolean

Has request object

Returns

getRequest()

getRequest() : \Pop\Http\Client\Request

Get the request object

Returns

request()

request() : \Pop\Http\Client\Request

Get the request object (alias method)

Returns

setResponse()

setResponse(\Pop\Http\Client\Response  $response) : \Pop\Http\Client\AbstractClient

Set the response object

Parameters

Returns

hasResponse()

hasResponse() : boolean

Has response object

Returns

getResponse()

getResponse() : \Pop\Http\Client\Response

Get the response object

Returns

getParsedResponse()

getParsedResponse() : mixed

Get the parsed response

Returns

response()

response() : \Pop\Http\Client\Response

Get the response object (alias method)

Returns

setField()

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

Set a field

Parameters

Returns

setFields()

setFields(array  $fields) : \Pop\Http\Client\AbstractClient

Set all fields

Parameters

Returns

getField()

getField(string  $name) : mixed

Get a field

Parameters

Returns

getFields()

getFields() : array

Get all field

Returns

removeField()

removeField(string  $name) : \Pop\Http\Client\AbstractClient

Remove a field

Parameters

Returns

addRequestHeaders()

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

Add request headers

Parameters

Returns

addRequestHeader()

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

Add request header

Parameters

Returns

hasRequestHeaders()

hasRequestHeaders() : boolean

Has request headers

Returns

hasRequestHeader()

hasRequestHeader(string  $name) : boolean

Has request header

Parameters

Returns

getRequestHeaders()

getRequestHeaders() : array

Get the request headers

Returns

getRequestHeader()

getRequestHeader(string  $name) : mixed

Get the request header

Parameters

Returns

getRequestBody()

getRequestBody() : string

Get the request body

Returns

createAsJson()

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

Create request as JSON

Returns

isJson()

isJson() : boolean

Check if request is JSON

Returns

createUrlEncodedForm()

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

Create request as a URL-encoded form

Returns

isUrlEncodedForm()

isUrlEncodedForm() : boolean

Check if request is a URL-encoded form

Returns

createMultipartForm()

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

Create request as a multipart form

Returns

isMultipartForm()

isMultipartForm() : boolean

Check if request is a multipart form

Returns

addResponseHeaders()

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

Add response headers

Parameters

Returns

addResponseHeader()

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

Add response header

Parameters

Returns

hasResponseHeaders()

hasResponseHeaders() : boolean

Has response headers

Returns

hasResponseHeader()

hasResponseHeader(string  $name) : boolean

Has response header

Parameters

Returns

getResponseHeaders()

getResponseHeaders() : array

Get the response headers

Returns

getResponseHeader()

getResponseHeader(string  $name) : mixed

Get the response header

Parameters

Returns

getResponseBody()

getResponseBody() : string

Get the response body

Returns

getResponseCode()

getResponseCode() : string

Get the response code

Returns

throwError()

throwError(string  $error) : void

Throw an exception upon an error.

Parameters

Throws

\Pop\Http\Client\Exception

open()

open() : \Pop\Http\Client\Curl

Create and open cURL resource

Returns

send()

send() : void

Method to send the request and get the response

curl()

curl() : resource

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

Returns

setOption()

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

Set cURL session option

Parameters

Returns

setOptions()

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

Set cURL session options

Parameters

Returns

setReturnHeader()

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

Set cURL option to return the header

Parameters

Returns

setReturnTransfer()

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

Set cURL option to return the transfer

Parameters

Returns

isReturnHeader()

isReturnHeader() : boolean

Check if cURL is set to return header

Returns

isReturnTransfer()

isReturnTransfer() : boolean

Check if cURL is set to return transfer

Returns

getOption()

getOption(integer  $opt) : string

Get a cURL session option

Parameters

Returns

hasOption()

hasOption(integer  $opt) : boolean

Has a cURL session option

Parameters

Returns

getInfo()

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

Return the cURL session last info

Parameters

Returns

version()

version() : array

Return the cURL version

Returns

disconnect()

disconnect() : void

Close the cURL connection