oxCurl Class Reference

Collaboration diagram for oxCurl:

Public Member Functions
	setUrl ($sUrl)
	getUrl ()
	setQuery ($sQuery)
	getQuery ()
	setParameters ($aParameters)
	getParameters ()
	setHost ($sHost)
	getHost ()
	setHeader ($aHeader=null)
	getHeader ()
	setMethod ($sMethod)
	getMethod ()
	setOption ($sName, $sValue)
	getOptions ()
	execute ()
	setConnectionCharset ($sCharset)
	getConnectionCharset ()
	getStatusCode ()

Public Attributes
const	EXECUTION_TIMEOUT_OPTION = 'CURLOPT_TIMEOUT'

Protected Member Functions
	_setResource ($rCurl)
	_getResource ()
	_setOptions ()
	_execute ()
	_close ()
	_setOpt ($sName, $sValue)
	_getErrorNumber ()
	_saveStatusCode ()
	_prepareQueryParameters ($aParams)
	_htmlDecode ($mParam)

Protected Attributes
	$_rCurl = null
	$_sUrl = null
	$_sQuery = null
	$_sMethod = 'POST'
	$_aParameters = null
	$_sConnectionCharset = "UTF-8"
	$_aHeader = null
	$_sHost = null
	$_aOptions = array('CURLOPT_RETURNTRANSFER' => 1)
	$_sStatusCode = null

Detailed Description

CURL request handler. Handles CURL calls

Definition at line 9 of file oxcurl.php.

Member Function Documentation

oxCurl::_close ( )

protected

Wrapper function to be mocked for testing.

Definition at line 389 of file oxcurl.php.

oxCurl::_execute ( )

protected

Wrapper function to be mocked for testing.

Returns

string

Definition at line 381 of file oxcurl.php.

oxCurl::_getErrorNumber ( )

protected

Check if curl has errors. Set error message if has.

Returns

int

Definition at line 411 of file oxcurl.php.

oxCurl::_getResource ( )

protected

Returns curl resource

Returns

resource

Definition at line 344 of file oxcurl.php.

oxCurl::_htmlDecode (   $mParam )

protected

Decode (if needed) html entity.

Parameters

mixed

$mParam

query

Returns

string

Definition at line 446 of file oxcurl.php.

oxCurl::_prepareQueryParameters (   $aParams )

protected

Decodes html entities.

Parameters

array

$aParams

Parameters.

Returns

array

Definition at line 431 of file oxcurl.php.

oxCurl::_saveStatusCode ( )

protected

Sets current request HTTP status code.

Definition at line 419 of file oxcurl.php.

oxCurl::_setOpt (   $sName,   $sValue  )

protected

Wrapper function to be mocked for testing.

Parameters

string	$sName	curl option name to set value to.
string	$sValue	curl option value to set.

Definition at line 401 of file oxcurl.php.

oxCurl::_setOptions ( )

protected

Set Curl Options

Definition at line 356 of file oxcurl.php.

oxCurl::_setResource (   $rCurl )

protected

Sets resource

Parameters

resource

$rCurl

curl.

Definition at line 334 of file oxcurl.php.

oxCurl::execute

(

)

Executes curl call and returns response data as associative array.

Exceptions

oxException

on curl errors

Returns

string

Definition at line 275 of file oxcurl.php.

oxCurl::getConnectionCharset

(

)

Return connection charset

Returns

string

Definition at line 314 of file oxcurl.php.

oxCurl::getHeader

(

)

Forms header from host.

Returns

array

Definition at line 206 of file oxcurl.php.

oxCurl::getHost

(

)

Returns host.

Returns

string

Definition at line 175 of file oxcurl.php.

oxCurl::getMethod

(

)

Return method to send

Returns

string

Definition at line 230 of file oxcurl.php.

oxCurl::getOptions

(

)

Gets all options for a cURL transfer

Returns

array

Definition at line 263 of file oxcurl.php.

oxCurl::getParameters

(

)

Return parameters to be added to call url.

Returns

array

Definition at line 155 of file oxcurl.php.

oxCurl::getQuery

(

)

Builds query like "param1=value1&param2=values2.."

Returns

string

Definition at line 125 of file oxcurl.php.

oxCurl::getStatusCode

(

)

Return HTTP status code.

Returns

int HTTP status code.

Definition at line 324 of file oxcurl.php.

oxCurl::getUrl

(

)

Get url

Returns

string

Definition at line 101 of file oxcurl.php.

oxCurl::setConnectionCharset

(

$sCharset

)

Set connection charset

Parameters

string

$sCharset

charset

Definition at line 304 of file oxcurl.php.

oxCurl::setHeader

(

$aHeader = null

)

Set header.

Parameters

array

$aHeader

Definition at line 185 of file oxcurl.php.

oxCurl::setHost

(

$sHost

)

Sets host.

Parameters

string

$sHost

Definition at line 165 of file oxcurl.php.

oxCurl::setMethod

(

$sMethod

)

Set method to send (POST/GET)

Parameters

string

$sMethod

method to send (POST/GET)

Definition at line 220 of file oxcurl.php.

oxCurl::setOption	(		$sName,
			$sValue
	)

Sets an option for a cURL transfer

Parameters

string	$sName	curl option name to set value to.
string	$sValue	curl option value to set.

Exceptions

oxException

on curl errors

Definition at line 243 of file oxcurl.php.

oxCurl::setParameters

(

$aParameters

)

Sets parameters to be added to call url.

Parameters

array

$aParameters

parameters

Definition at line 144 of file oxcurl.php.

oxCurl::setQuery

(

$sQuery

)

Set query like "param1=value1&param2=values2.."

Parameters

string

$sQuery

Request query.

Definition at line 115 of file oxcurl.php.

oxCurl::setUrl

(

$sUrl

)

Sets url to call

Parameters

string

$sUrl

URL to call.

Exceptions

oxException

if url is not valid

Definition at line 91 of file oxcurl.php.

Member Data Documentation

oxCurl::$_aHeader = null

protected

Definition at line 61 of file oxcurl.php.

oxCurl::$_aOptions = array('CURLOPT_RETURNTRANSFER' => 1)

protected

Definition at line 75 of file oxcurl.php.

oxCurl::$_aParameters = null

protected

Definition at line 47 of file oxcurl.php.

oxCurl::$_rCurl = null

protected

Definition at line 19 of file oxcurl.php.

oxCurl::$_sConnectionCharset = "UTF-8"

protected

Definition at line 54 of file oxcurl.php.

oxCurl::$_sHost = null

protected

Definition at line 68 of file oxcurl.php.

oxCurl::$_sMethod = 'POST'

protected

Set CURL method

Returns

string

Definition at line 40 of file oxcurl.php.

oxCurl::$_sQuery = null

protected

Query like "param1=value1&param2=values2.."

Returns

string

Definition at line 33 of file oxcurl.php.

oxCurl::$_sStatusCode = null

protected

Definition at line 82 of file oxcurl.php.

oxCurl::$_sUrl = null

protected

Definition at line 26 of file oxcurl.php.

const oxCurl::EXECUTION_TIMEOUT_OPTION = 'CURLOPT_TIMEOUT'

Curl option for setting the timeout of whole execution process.

Definition at line 12 of file oxcurl.php.

---

The documentation for this class was generated from the following file:

• core/oxcurl.php