OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\Curl Class Reference
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Curl:

Public Member Functions

 setUrl ($url)
 
 getUrl ()
 
 setQuery ($query)
 
 getQuery ()
 
 setParameters ($parameters)
 
 getParameters ()
 
 setHost ($host)
 
 getHost ()
 
 setHeader ($header=null)
 
 getHeader ()
 
 setMethod ($method)
 
 getMethod ()
 
 setOption ($name, $value)
 
 getOptions ()
 
 execute ()
 
 setConnectionCharset ($charset)
 
 getConnectionCharset ()
 
 getStatusCode ()
 

Public Attributes

const EXECUTION_TIMEOUT_OPTION = 'CURLOPT_TIMEOUT'
 
const CONNECT_TIMEOUT_OPTION = 'CURLOPT_CONNECTTIMEOUT'
 

Protected Member Functions

 _setResource ($rCurl)
 
 _getResource ()
 
 _setOptions ()
 
 _execute ()
 
 _close ()
 
 _setOpt ($name, $value)
 
 _getErrorNumber ()
 
 _saveStatusCode ()
 
 _prepareQueryParameters ($params)
 
 _htmlDecode ($mParam)
 

Protected Attributes

 $_rCurl = null
 
 $_sUrl = null
 
 $_sQuery = null
 
 $_sMethod = 'POST'
 
 $_aParameters = null
 
 $_sConnectionCharset = "UTF-8"
 
 $_aHeader = null
 
 $_sHost = null
 
 $_aOptions = ['CURLOPT_RETURNTRANSFER' => 1]
 
 $_sStatusCode = null
 

Detailed Description

CURL request handler. Handles CURL calls

Member Function Documentation

◆ _close()

OxidEsales\EshopCommunity\Core\Curl::_close ( )
protected

Wrapper function to be mocked for testing.

◆ _execute()

OxidEsales\EshopCommunity\Core\Curl::_execute ( )
protected

Wrapper function to be mocked for testing.

Returns
string

◆ _getErrorNumber()

OxidEsales\EshopCommunity\Core\Curl::_getErrorNumber ( )
protected

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

Returns
int

◆ _getResource()

OxidEsales\EshopCommunity\Core\Curl::_getResource ( )
protected

Returns curl resource

Returns
resource

◆ _htmlDecode()

OxidEsales\EshopCommunity\Core\Curl::_htmlDecode (   $mParam)
protected

Decode (if needed) html entity.

Parameters
mixed$mParamquery
Returns
string

◆ _prepareQueryParameters()

OxidEsales\EshopCommunity\Core\Curl::_prepareQueryParameters (   $params)
protected

Decodes html entities.

Parameters
array$paramsParameters.
Returns
array

◆ _saveStatusCode()

OxidEsales\EshopCommunity\Core\Curl::_saveStatusCode ( )
protected

Sets current request HTTP status code.

◆ _setOpt()

OxidEsales\EshopCommunity\Core\Curl::_setOpt (   $name,
  $value 
)
protected

Wrapper function to be mocked for testing.

Parameters
string$namecurl option name to set value to.
string$valuecurl option value to set.

◆ _setOptions()

OxidEsales\EshopCommunity\Core\Curl::_setOptions ( )
protected

Set Curl Options

◆ _setResource()

OxidEsales\EshopCommunity\Core\Curl::_setResource (   $rCurl)
protected

Sets resource

Parameters
resource$rCurlcurl.

◆ execute()

OxidEsales\EshopCommunity\Core\Curl::execute ( )

Executes curl call and returns response data as associative array.

Exceptions
oxExceptionon curl errors
Returns
string

◆ getConnectionCharset()

OxidEsales\EshopCommunity\Core\Curl::getConnectionCharset ( )

Return connection charset

Returns
string

◆ getHeader()

OxidEsales\EshopCommunity\Core\Curl::getHeader ( )

Forms header from host.

Returns
array

◆ getHost()

OxidEsales\EshopCommunity\Core\Curl::getHost ( )

Returns host.

Returns
string

◆ getMethod()

OxidEsales\EshopCommunity\Core\Curl::getMethod ( )

Return method to send

Returns
string

◆ getOptions()

OxidEsales\EshopCommunity\Core\Curl::getOptions ( )

Gets all options for a cURL transfer

Returns
array

◆ getParameters()

OxidEsales\EshopCommunity\Core\Curl::getParameters ( )

Return parameters to be added to call url.

Returns
array

◆ getQuery()

OxidEsales\EshopCommunity\Core\Curl::getQuery ( )

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

Returns
string

◆ getStatusCode()

OxidEsales\EshopCommunity\Core\Curl::getStatusCode ( )

Return HTTP status code.

Returns
int HTTP status code.

◆ getUrl()

OxidEsales\EshopCommunity\Core\Curl::getUrl ( )

Get url

Returns
string

◆ setConnectionCharset()

OxidEsales\EshopCommunity\Core\Curl::setConnectionCharset (   $charset)

Set connection charset

Parameters
string$charsetcharset

◆ setHeader()

OxidEsales\EshopCommunity\Core\Curl::setHeader (   $header = null)

Set header.

Parameters
array$header

◆ setHost()

OxidEsales\EshopCommunity\Core\Curl::setHost (   $host)

Sets host.

Parameters
string$host

◆ setMethod()

OxidEsales\EshopCommunity\Core\Curl::setMethod (   $method)

Set method to send (POST/GET)

Parameters
string$methodmethod to send (POST/GET)

◆ setOption()

OxidEsales\EshopCommunity\Core\Curl::setOption (   $name,
  $value 
)

Sets an option for a cURL transfer

Parameters
string$namecurl option name to set value to.
string$valuecurl option value to set.
Exceptions
oxExceptionon curl errors

◆ setParameters()

OxidEsales\EshopCommunity\Core\Curl::setParameters (   $parameters)

Sets parameters to be added to call url.

Parameters
array$parametersparameters

◆ setQuery()

OxidEsales\EshopCommunity\Core\Curl::setQuery (   $query)

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

Parameters
string$queryRequest query.

◆ setUrl()

OxidEsales\EshopCommunity\Core\Curl::setUrl (   $url)

Sets url to call

Parameters
string$urlURL to call.
Exceptions
oxExceptionif url is not valid

Member Data Documentation

◆ $_aHeader

OxidEsales\EshopCommunity\Core\Curl::$_aHeader = null
protected

◆ $_aOptions

OxidEsales\EshopCommunity\Core\Curl::$_aOptions = ['CURLOPT_RETURNTRANSFER' => 1]
protected

◆ $_aParameters

OxidEsales\EshopCommunity\Core\Curl::$_aParameters = null
protected

◆ $_rCurl

OxidEsales\EshopCommunity\Core\Curl::$_rCurl = null
protected

◆ $_sConnectionCharset

OxidEsales\EshopCommunity\Core\Curl::$_sConnectionCharset = "UTF-8"
protected

◆ $_sHost

OxidEsales\EshopCommunity\Core\Curl::$_sHost = null
protected

◆ $_sMethod

OxidEsales\EshopCommunity\Core\Curl::$_sMethod = 'POST'
protected

Set CURL method

Returns
string

◆ $_sQuery

OxidEsales\EshopCommunity\Core\Curl::$_sQuery = null
protected

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

Returns
string

◆ $_sStatusCode

OxidEsales\EshopCommunity\Core\Curl::$_sStatusCode = null
protected

◆ $_sUrl

OxidEsales\EshopCommunity\Core\Curl::$_sUrl = null
protected

◆ CONNECT_TIMEOUT_OPTION

const OxidEsales\EshopCommunity\Core\Curl::CONNECT_TIMEOUT_OPTION = 'CURLOPT_CONNECTTIMEOUT'

Curl option for setting the timeout for connect.

◆ EXECUTION_TIMEOUT_OPTION

const OxidEsales\EshopCommunity\Core\Curl::EXECUTION_TIMEOUT_OPTION = 'CURLOPT_TIMEOUT'

Curl option for setting the timeout of whole execution process.


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