OxidEsales\EshopCommunity\Core\SystemEventHandler Class Reference

Public Member Functions
	setOnlineLicenseCheck (\OxidEsales\Eshop\Core\OnlineLicenseCheck $onlineLicenseCheck)
	getOnlineLicenseCheck ()
	setOnlineModuleVersionNotifier (\OxidEsales\Eshop\Core\OnlineModuleVersionNotifier $onlineModuleVersionNotifier)
	getOnlineModuleVersionNotifier ()
	onAdminLogin ()
	onShopStart ()
	onShopEnd ()

Protected Member Functions
	getApplicationServerExporter ()
	validateOnline ()
	isSendingShopDataEnabled ()
	sendShopInformation ()
	validateOffline ()
	getConfig ()
	getAppServerService ()

Private Member Functions
	needToSendShopInformation ()
	getNextCheckTime ()
	updateNextCheckTime ()
	getCheckTime ()
	getCurrentTime ()

Private Attributes
	$onlineModuleVersionNotifier = null
	$onlineLicenseCheck = null

Detailed Description

Contains system event handler methods

Member Function Documentation

getApplicationServerExporter()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getApplicationServerExporter ( )

protected

ApplicationServerExporter dependency setter

Returns

\OxidEsales\Eshop\Core\Service\ApplicationServerExporterInterface

getAppServerService()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getAppServerService ( )

protected

Gets application server service.

Returns

\OxidEsales\Eshop\Core\Service\ApplicationServerServiceInterface

getCheckTime()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getCheckTime ( )

private

Returns time (hour minutes seconds) when to perform license check. Create if does not exist.

Returns

string time formed as H:i:s

getConfig()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getConfig ( )

protected

Return Config from registry.

Returns

\OxidEsales\Eshop\Core\Config

getCurrentTime()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getCurrentTime ( )

private

Return current time - time stamp.

Returns

int

getNextCheckTime()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getNextCheckTime ( )

private

Return time stamp when shop was checked last with white noise from config.

Returns

int

getOnlineLicenseCheck()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getOnlineLicenseCheck

(

)

OLC dependency getter

Returns

\OxidEsales\Eshop\Core\OnlineLicenseCheck

getOnlineModuleVersionNotifier()

OxidEsales\EshopCommunity\Core\SystemEventHandler::getOnlineModuleVersionNotifier

(

)

OnlineModuleVersionNotifier dependency getter

Returns

\OxidEsales\Eshop\Core\OnlineModuleVersionNotifier

isSendingShopDataEnabled()

OxidEsales\EshopCommunity\Core\SystemEventHandler::isSendingShopDataEnabled ( )

protected

Checks if sending shop data is enabled.

Returns

bool

needToSendShopInformation()

OxidEsales\EshopCommunity\Core\SystemEventHandler::needToSendShopInformation ( )

private

Check if need to send information. We will not send information on each request due to possible performance drop.

Returns

bool

onAdminLogin()

OxidEsales\EshopCommunity\Core\SystemEventHandler::onAdminLogin

(

)

onAdminLogin() is called on every successful login to the backend

onShopEnd()

OxidEsales\EshopCommunity\Core\SystemEventHandler::onShopEnd

(

)

Perform shop finishing up related actions, like updating app server data.

onShopStart()

OxidEsales\EshopCommunity\Core\SystemEventHandler::onShopStart

(

)

Perform shop startup related actions, like license check.

sendShopInformation()

OxidEsales\EshopCommunity\Core\SystemEventHandler::sendShopInformation ( )

protected

Sends shop information to oxid servers.

setOnlineLicenseCheck()

OxidEsales\EshopCommunity\Core\SystemEventHandler::setOnlineLicenseCheck

(

\OxidEsales\Eshop\Core\OnlineLicenseCheck

$onlineLicenseCheck

)

OLC dependency setter

Parameters

\OxidEsales\Eshop\Core\OnlineLicenseCheck

$onlineLicenseCheck

setOnlineModuleVersionNotifier()

OxidEsales\EshopCommunity\Core\SystemEventHandler::setOnlineModuleVersionNotifier

(

\OxidEsales\Eshop\Core\OnlineModuleVersionNotifier

$onlineModuleVersionNotifier

)

OnlineModuleVersionNotifier dependency setter

Parameters

\OxidEsales\Eshop\Core\OnlineModuleVersionNotifier

$onlineModuleVersionNotifier

updateNextCheckTime()

OxidEsales\EshopCommunity\Core\SystemEventHandler::updateNextCheckTime ( )

private

Update when shop was checked last time with white noise. White noise is used to separate call time for different shop.

validateOffline()

OxidEsales\EshopCommunity\Core\SystemEventHandler::validateOffline ( )

protected

Check if shop valid and do related actions.

validateOnline()

OxidEsales\EshopCommunity\Core\SystemEventHandler::validateOnline ( )

protected

Check if shop is valid online.

Member Data Documentation

$onlineLicenseCheck

OxidEsales\EshopCommunity\Core\SystemEventHandler::$onlineLicenseCheck = null

private

$onlineModuleVersionNotifier

OxidEsales\EshopCommunity\Core\SystemEventHandler::$onlineModuleVersionNotifier = null

private

---

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

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