oxOnlineLicenseCheckCaller Class Reference

Inheritance diagram for oxOnlineLicenseCheckCaller:

Collaboration diagram for oxOnlineLicenseCheckCaller:

Public Member Functions
	doRequest (oxOnlineLicenseCheckRequest $oRequest)
Public Member Functions inherited from oxOnlineCaller
	__construct (oxCurl $oCurl, oxOnlineServerEmailBuilder $oEmailBuilder, oxSimpleXml $oSimpleXml)
	call (oxOnlineRequest $oRequest)

Public Attributes
const	WEB_SERVICE_URL = 'https://olc.oxid-esales.com/check.php'
const	XML_DOCUMENT_NAME = 'olcRequest'
Public Attributes inherited from oxOnlineCaller
const	ALLOWED_HTTP_FAILED_CALLS_COUNT = 4
const	CURL_EXECUTION_TIMEOUT = 5

Protected Member Functions
	_formEmail ($oRequest)
	_formResponse ($sRawResponse)
	_getXMLDocumentName ()
	_getServiceUrl ()
Protected Member Functions inherited from oxOnlineCaller
	_formXMLRequest ($oRequest)
	_getSimpleXml ()
	_getCurl ()
	_getEmailBuilder ()

Private Attributes
	$_sResponseElement = 'olc'

Detailed Description

Class makes call to given URL address and sends request parameter.

Definition at line 11 of file oxonlinelicensecheckcaller.php.

Member Function Documentation

oxOnlineLicenseCheckCaller::_formEmail (   $oRequest )

protected

Removes serial keys from request and forms email body.

Parameters

oxOnlineLicenseCheckRequest

$oRequest

Returns

string

Reimplemented from oxOnlineCaller.

Definition at line 49 of file oxonlinelicensecheckcaller.php.

oxOnlineLicenseCheckCaller::_formResponse (   $sRawResponse )

protected

Parse response message received from Online License Key Check web service and save it to response object.

Parameters

string

$sRawResponse

Exceptions

oxException

Returns

oxOnlineLicenseCheckResponse

Definition at line 65 of file oxonlinelicensecheckcaller.php.

oxOnlineLicenseCheckCaller::_getServiceUrl ( )

protected

Gets service url.

Returns

string Web service url.

Reimplemented from oxOnlineCaller.

Definition at line 113 of file oxonlinelicensecheckcaller.php.

oxOnlineLicenseCheckCaller::_getXMLDocumentName ( )

protected

Gets XML document name.

Returns

string XML document tag name.

Reimplemented from oxOnlineCaller.

Definition at line 103 of file oxonlinelicensecheckcaller.php.

oxOnlineLicenseCheckCaller::doRequest

(

oxOnlineLicenseCheckRequest

$oRequest

)

Performs Web service request

Parameters

oxOnlineLicenseCheckRequest

$oRequest

Object with request parameters

Exceptions

oxException

Returns

oxOnlineLicenseCheckResponse

Definition at line 35 of file oxonlinelicensecheckcaller.php.

Member Data Documentation

oxOnlineLicenseCheckCaller::$_sResponseElement = 'olc'

private

Definition at line 25 of file oxonlinelicensecheckcaller.php.

const oxOnlineLicenseCheckCaller::WEB_SERVICE_URL = 'https://olc.oxid-esales.com/check.php'

Online License Key Check web service url.

Definition at line 15 of file oxonlinelicensecheckcaller.php.

const oxOnlineLicenseCheckCaller::XML_DOCUMENT_NAME = 'olcRequest'

XML document tag name.

Definition at line 18 of file oxonlinelicensecheckcaller.php.

---

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

• core/oxonlinelicensecheckcaller.php