Public Member Functions | Protected Member Functions | Protected Attributes

oxCurl Class Reference

List of all members.

Public Member Functions

 setUrl ($sUrl)
 getUrl ()
 setQuery ($sQuery)
 getQuery ()
 setParameters ($aParameters)
 getParameters ()
 setHost ($sHost)
 getHost ()
 setHeader ($aHeader=null)
 getHeader ()
 setMethod ($sMethod)
 getMethod ()
 getOptions ()
 setConnectionCharset ($sCharset)
 getConnectionCharset ()
 getStatusCode ()

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 387 of file oxcurl.php.

oxCurl._execute (  )  [protected]

Wrapper function to be mocked for testing.

Returns:
string

Definition at line 379 of file oxcurl.php.

oxCurl._getErrorNumber (  )  [protected]

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

Returns:
int

Definition at line 409 of file oxcurl.php.

oxCurl._getResource (  )  [protected]

Returns curl resource

Returns:
resource

Definition at line 342 of file oxcurl.php.

oxCurl._htmlDecode ( mParam  )  [protected]

Decode (if needed) html entity.

Parameters:
mixed $mParam query
Returns:
string

Definition at line 444 of file oxcurl.php.

oxCurl._prepareQueryParameters ( aParams  )  [protected]

Decodes html entities.

Parameters:
array $aParams Parameters.
Returns:
array

Definition at line 429 of file oxcurl.php.

oxCurl._saveStatusCode (  )  [protected]

Sets current request HTTP status code.

Definition at line 417 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 399 of file oxcurl.php.

oxCurl._setOptions (  )  [protected]

Set Curl Options

Definition at line 354 of file oxcurl.php.

oxCurl._setResource ( rCurl  )  [protected]

Sets resource

Parameters:
resource $rCurl curl.

Definition at line 332 of file oxcurl.php.

oxCurl.getConnectionCharset (  ) 

Return connection charset

Returns:
string

Definition at line 312 of file oxcurl.php.

oxCurl.getHeader (  ) 

Forms header from host.

Returns:
array

Definition at line 204 of file oxcurl.php.

oxCurl.getHost (  ) 

Returns host.

Returns:
string

Definition at line 173 of file oxcurl.php.

oxCurl.getMethod (  ) 

Return method to send

Returns:
string

Definition at line 228 of file oxcurl.php.

oxCurl.getOptions (  ) 

Gets all options for a cURL transfer

Returns:
array

Definition at line 261 of file oxcurl.php.

oxCurl.getParameters (  ) 

Return parameters to be added to call url.

Returns:
array

Definition at line 153 of file oxcurl.php.

oxCurl.getQuery (  ) 

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

Returns:
string

Definition at line 123 of file oxcurl.php.

oxCurl.getStatusCode (  ) 

Return HTTP status code.

Returns:
int HTTP status code.

Definition at line 322 of file oxcurl.php.

oxCurl.getUrl (  ) 

Get url

Returns:
string

Definition at line 99 of file oxcurl.php.

oxCurl.setConnectionCharset ( sCharset  ) 

Set connection charset

Parameters:
string $sCharset charset

Definition at line 302 of file oxcurl.php.

oxCurl.setHeader ( aHeader = null  ) 

Set header.

Parameters:
array $aHeader

Definition at line 183 of file oxcurl.php.

oxCurl.setHost ( sHost  ) 

Sets host.

Parameters:
string $sHost

Definition at line 163 of file oxcurl.php.

oxCurl.setMethod ( sMethod  ) 

Set method to send (POST/GET)

Parameters:
string $sMethod method to send (POST/GET)

Definition at line 218 of file oxcurl.php.

oxCurl.setParameters ( aParameters  ) 

Sets parameters to be added to call url.

Parameters:
array $aParameters parameters

Definition at line 142 of file oxcurl.php.

oxCurl.setQuery ( sQuery  ) 

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

Parameters:
string $sQuery Request query.

Definition at line 113 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 89 of file oxcurl.php.


Member Data Documentation

oxCurl.$_aHeader = null [protected]

Definition at line 59 of file oxcurl.php.

oxCurl.$_aOptions = array('CURLOPT_RETURNTRANSFER' => 1) [protected]

Definition at line 73 of file oxcurl.php.

oxCurl.$_aParameters = null [protected]

Definition at line 45 of file oxcurl.php.

oxCurl.$_rCurl = null [protected]

Definition at line 17 of file oxcurl.php.

oxCurl.$_sConnectionCharset = "UTF-8" [protected]

Definition at line 52 of file oxcurl.php.

oxCurl.$_sHost = null [protected]

Definition at line 66 of file oxcurl.php.

oxCurl.$_sMethod = 'POST' [protected]

Set CURL method

Returns:
string

Definition at line 38 of file oxcurl.php.

oxCurl.$_sQuery = null [protected]

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

Returns:
string

Definition at line 31 of file oxcurl.php.

oxCurl.$_sStatusCode = null [protected]

Definition at line 80 of file oxcurl.php.

oxCurl.$_sUrl = null [protected]

Definition at line 24 of file oxcurl.php.


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