OxidEsales\EshopCommunity\Core\OnlineLicenseCheck Class Reference

Collaboration diagram for OxidEsales\EshopCommunity\Core\OnlineLicenseCheck:

Public Member Functions
	setAppServerExporter ($appServerExporter)
	getAppServerExporter ()
	setUserCounter ($userCounter)
	__construct ($caller)
	getErrorMessage ()
	isException ()
	validateShopSerials ()
	validateNewSerial ($serial)
	validate ($serials)

Public Attributes
const	CONFIG_VAR_NAME = 'iOlcSuccess'

Protected Member Functions
	getUserCounter ()
	setErrorMessage ($errorMessage)
	getCaller ()
	validateResponse ($response)
	formRequest ($serials)
	formCounters ()
	logSuccess ()
	setIsException ($isException)
	startGracePeriod ()

Protected Attributes
	$validResponseCode = 0
	$validResponseMessage = 'ACK'
	$serialKeys = []
	$errorMessage = ''
	$isException = false
	$caller = null
	$userCounter = null
	$appServerExporter = null

Detailed Description

Performs Online License Key check.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::__construct

(

$caller

)

Sets dependencies.

Parameters

\OxidEsales\Eshop\Core\OnlineLicenseCheckCaller

$caller

Member Function Documentation

formCounters()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::formCounters ( )

protected

Forms shop counters array for sending to OXID server.

Returns

array

formRequest()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::formRequest (   $serials )

protected

Builds request object with required parameters.

Parameters

array

$serials

Array of serials to add to request.

Exceptions

oxException

Returns

\OxidEsales\Eshop\Core\OnlineLicenseCheckRequest

getAppServerExporter()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::getAppServerExporter

(

)

Gets servers manager.

Returns

\OxidEsales\Eshop\Core\Service\ApplicationServerExporterInterface

getCaller()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::getCaller ( )

protected

Gets caller.

Returns

\OxidEsales\Eshop\Core\OnlineLicenseCheckCaller

getErrorMessage()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::getErrorMessage

(

)

Get error message.

Returns

string

getUserCounter()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::getUserCounter ( )

protected

Gets user counter.

Returns

\OxidEsales\Eshop\Core\UserCounter

isException()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::isException

(

)

Indicates whether the exception was thrown

Returns

bool

logSuccess()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::logSuccess ( )

protected

Registers the latest Successful Online License check.

setAppServerExporter()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::setAppServerExporter

(

$appServerExporter

)

Sets servers manager.

Parameters

\OxidEsales\Eshop\Core\Service\ApplicationServerExporterInterface

$appServerExporter

setErrorMessage()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::setErrorMessage (   $errorMessage )

protected

Set error message.

Parameters

string

$errorMessage

Error message

setIsException()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::setIsException (   $isException )

protected

Sets exception flag.

Parameters

bool

$isException

Exception flag.

setUserCounter()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::setUserCounter

(

$userCounter

)

Sets user counter.

Parameters

\OxidEsales\Eshop\Core\UserCounter

$userCounter

startGracePeriod()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::startGracePeriod ( )

protected

Starts grace period. Sets to config options.

validate()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::validate

(

$serials

)

The Online shop license check is performed. Returns check result.

Parameters

array

$serials

Serial keys to be checked.

Returns

bool

validateNewSerial()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::validateNewSerial

(

$serial

)

The Online shop license check for the new serial is performed. Returns check result.

Parameters

string

$serial

Serial to check.

Returns

bool

validateResponse()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::validateResponse (   $response )

protected

Performs a check of the response code and message.

Parameters

\OxidEsales\Eshop\Core\OnlineLicenseCheckResponse

$response

Exceptions

validateShopSerials()

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::validateShopSerials

(

)

Takes active serial key and performs online license check in case it has never been performed before. In case of invalid license key, eShop is declared as unlicensed. In case of validation exception (eg. service can not be reached) the check is postponed until the next call.

Member Data Documentation

$appServerExporter

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$appServerExporter = null

protected

$caller

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$caller = null

protected

$errorMessage

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$errorMessage = ''

protected

$isException

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$isException = false

protected

$serialKeys

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$serialKeys = []

protected

$userCounter

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$userCounter = null

protected

$validResponseCode

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$validResponseCode = 0

protected

$validResponseMessage

OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::$validResponseMessage = 'ACK'

protected

CONFIG_VAR_NAME

const OxidEsales\EshopCommunity\Core\OnlineLicenseCheck::CONFIG_VAR_NAME = 'iOlcSuccess'

Variable name to be used in oxConfig table

---

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

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