OxidEsales\EshopCommunity\Core\OnlineCaller Class Reference

Collaboration diagram for OxidEsales\EshopCommunity\Core\OnlineCaller:

Public Member Functions
	__construct (\OxidEsales\Eshop\Core\Curl $oCurl, \OxidEsales\Eshop\Core\OnlineServerEmailBuilder $oEmailBuilder, \OxidEsales\Eshop\Core\SimpleXml $oSimpleXml)
	call (\OxidEsales\Eshop\Core\OnlineRequest $oRequest)

Public Attributes
const	ALLOWED_HTTP_FAILED_CALLS_COUNT = 4
const	CURL_EXECUTION_TIMEOUT = 5
const	CURL_CONNECT_TIMEOUT = 3

Protected Member Functions
	_getXMLDocumentName ()
	_getServiceUrl ()
	_castExceptionAndWriteToLog (\Exception $oEx)
	_formEmail ($oRequest)
	_formXMLRequest ($oRequest)
	_getSimpleXml ()
	_getCurl ()
	_getEmailBuilder ()

Private Member Functions
	_executeCurlCall ($sUrl, $sXml)
	_sendEmail ($sBody)
	_resetFailedCallsCount ($iFailedOnlineCallsCount)
	_increaseFailedCallsCount ($iFailedOnlineCallsCount)

Private Attributes
	$_oCurl
	$_oEmailBuilder
	$_oSimpleXml

Detailed Description

Class oxOnlineCaller makes call to given URL which is taken from child classes and sends request parameter.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\OnlineCaller::__construct	(	\OxidEsales\Eshop\Core\Curl	$oCurl,
		\OxidEsales\Eshop\Core\OnlineServerEmailBuilder	$oEmailBuilder,
		\OxidEsales\Eshop\Core\SimpleXml	$oSimpleXml
	)

Sets dependencies.

Parameters

\OxidEsales\Eshop\Core\Curl	$oCurl	Sends request to OXID servers.
\OxidEsales\Eshop\Core\OnlineServerEmailBuilder	$oEmailBuilder	Forms email when OXID servers are unreachable.
\OxidEsales\Eshop\Core\SimpleXml	$oSimpleXml	Forms XML from Request for sending to OXID servers.

Member Function Documentation

_castExceptionAndWriteToLog()

OxidEsales\EshopCommunity\Core\OnlineCaller::_castExceptionAndWriteToLog ( \Exception  $oEx )

protected

Depending on the type of exception, first cast the exception and then write it to log.

Deprecated:

since v6.3 (2018-04-25); This method will be removed completely. Use Registry::getLogger() to log error messages in the future.

Parameters

\Exception

$oEx

_executeCurlCall()

OxidEsales\EshopCommunity\Core\OnlineCaller::_executeCurlCall (   $sUrl,   $sXml  )

private

Executes CURL call with given parameters.

Parameters

string	$sUrl	Server address to call to.
string	$sXml	Data to send. Currently OXID servers only accept XML formatted data.

Returns

string

_formEmail()

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

protected

Forms email.

Parameters

\OxidEsales\Eshop\Core\OnlineRequest

$oRequest

Request object from which email should be formed.

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "formEmail" in next major

_formXMLRequest()

OxidEsales\EshopCommunity\Core\OnlineCaller::_formXMLRequest (   $oRequest )

protected

Forms XML request.

Parameters

\OxidEsales\Eshop\Core\OnlineRequest

$oRequest

Request object from which server request should be formed.

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "formXMLRequest" in next major

_getCurl()

OxidEsales\EshopCommunity\Core\OnlineCaller::_getCurl ( )

protected

Gets curl.

Returns

\OxidEsales\Eshop\Core\Curl

Deprecated:

underscore prefix violates PSR12, will be renamed to "getCurl" in next major

_getEmailBuilder()

OxidEsales\EshopCommunity\Core\OnlineCaller::_getEmailBuilder ( )

protected

Gets email builder.

Returns

\OxidEsales\Eshop\Core\OnlineServerEmailBuilder

Deprecated:

underscore prefix violates PSR12, will be renamed to "getEmailBuilder" in next major

_getServiceUrl()

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

abstractprotected

Gets service url.

Returns

string Web service url.

Deprecated:

underscore prefix violates PSR12, will be renamed to "getServiceUrl" in next major

_getSimpleXml()

OxidEsales\EshopCommunity\Core\OnlineCaller::_getSimpleXml ( )

protected

Gets simple XML.

Returns

\OxidEsales\Eshop\Core\SimpleXml

Deprecated:

underscore prefix violates PSR12, will be renamed to "getSimpleXml" in next major

_getXMLDocumentName()

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

abstractprotected

Gets XML document name.

Returns

string XML document tag name.

Deprecated:

underscore prefix violates PSR12, will be renamed to "getXMLDocumentName" in next major

_increaseFailedCallsCount()

OxidEsales\EshopCommunity\Core\OnlineCaller::_increaseFailedCallsCount (   $iFailedOnlineCallsCount )

private

increases failed calls count.

Parameters

int

$iFailedOnlineCallsCount

Amount of calls which previously failed.

_resetFailedCallsCount()

OxidEsales\EshopCommunity\Core\OnlineCaller::_resetFailedCallsCount (   $iFailedOnlineCallsCount )

private

Resets config parameter iFailedOnlineCallsCount if it's bigger than 0.

Parameters

int

$iFailedOnlineCallsCount

Amount of calls which previously failed.

_sendEmail()

OxidEsales\EshopCommunity\Core\OnlineCaller::_sendEmail (   $sBody )

private

Sends an email with server information.

Parameters

string

$sBody

Mail content.

call()

OxidEsales\EshopCommunity\Core\OnlineCaller::call

(

\OxidEsales\Eshop\Core\OnlineRequest

$oRequest

)

Makes curl call with given parameters to given url.

Parameters

\OxidEsales\Eshop\Core\OnlineRequest

$oRequest

Information set in Request object will be sent to OXID servers.

Returns

null|string In XML format.

Member Data Documentation

$_oCurl

OxidEsales\EshopCommunity\Core\OnlineCaller::$_oCurl

private

$_oEmailBuilder

OxidEsales\EshopCommunity\Core\OnlineCaller::$_oEmailBuilder

private

$_oSimpleXml

OxidEsales\EshopCommunity\Core\OnlineCaller::$_oSimpleXml

private

ALLOWED_HTTP_FAILED_CALLS_COUNT

const OxidEsales\EshopCommunity\Core\OnlineCaller::ALLOWED_HTTP_FAILED_CALLS_COUNT = 4

CURL_CONNECT_TIMEOUT

const OxidEsales\EshopCommunity\Core\OnlineCaller::CURL_CONNECT_TIMEOUT = 3

Amount of seconds for curl connect timeout.

CURL_EXECUTION_TIMEOUT

const OxidEsales\EshopCommunity\Core\OnlineCaller::CURL_EXECUTION_TIMEOUT = 5

Amount of seconds for curl execution timeout.

---

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

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