OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller:

Collaboration diagram for OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller:

Public Member Functions
	doRequest (\OxidEsales\Eshop\Core\OnlineLicenseCheckRequest $oRequest)

Public Attributes
const	WEB_SERVICE_URL = 'https://olc.oxid-esales.com/check.php'
const	XML_DOCUMENT_NAME = 'olcRequest'

Protected Member Functions
	_formEmail ($oRequest)
	_formResponse ($sRawResponse)
	_getXMLDocumentName ()
	_getServiceUrl ()

Private Attributes
	$_sResponseElement = 'olc'

Detailed Description

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

Member Function Documentation

_formEmail()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::_formEmail (   $oRequest )

protected

Removes serial keys from request and forms email body.

Parameters

\OxidEsales\Eshop\Core\OnlineLicenseCheckRequest

$oRequest

Returns

string

_formResponse()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::_formResponse (   $sRawResponse )

protected

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

Parameters

string

$sRawResponse

UnResponse from server

Exceptions

oxException

Returns

\OxidEsales\Eshop\Core\OnlineLicenseCheckResponse

_getServiceUrl()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::_getServiceUrl ( )

protected

Gets service url.

Returns

string Web service url.

_getXMLDocumentName()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::_getXMLDocumentName ( )

protected

Gets XML document name.

Returns

string XML document tag name.

doRequest()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::doRequest

(

\OxidEsales\Eshop\Core\OnlineLicenseCheckRequest

$oRequest

)

Performs Web service request

Parameters

\OxidEsales\Eshop\Core\OnlineLicenseCheckRequest

$oRequest

Object with request parameters

Exceptions

oxException

Returns

\OxidEsales\Eshop\Core\OnlineLicenseCheckResponse

Member Data Documentation

$_sResponseElement

OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::$_sResponseElement = 'olc'

private

WEB_SERVICE_URL

const OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::WEB_SERVICE_URL = 'https://olc.oxid-esales.com/check.php'

Online License Key Check web service url.

XML_DOCUMENT_NAME

const OxidEsales\EshopCommunity\Core\OnlineLicenseCheckCaller::XML_DOCUMENT_NAME = 'olcRequest'

XML document tag name.

---

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

• /oxideshop-ce/source/Core/OnlineLicenseCheckCaller.php