Documentation

License
in package

Description of License

Tags
author

ritt0r

Table of Contents

Constants

INFINITE_VALIDITY  = 0
LICENSE_DEMO  = 'DEMO'
LICENSE_ERROR  = 'ERROR'
LICENSE_NOK  = 'NOK'
LICENSE_OK  = 'OK'

Properties

$availableComponents  : mixed
$createdAt  : mixed
$customer  : mixed
$dashboardMessages  : mixed
$editionName  : mixed
$firstFailedUpdate  : mixed
$frontendLocked  : mixed
$frontendLockTime  : mixed
$grayzoneMessages  : mixed
$grayzoneTime  : mixed
$instId  : mixed
$isUpgradable  : mixed
$lastSuccessfulUpdate  : mixed
$legalComponents  : mixed
$legalComponentsAdditionalData  : mixed
$legalFrontendComponents  : mixed
$licenseKey  : mixed
$messages  : mixed
$partner  : mixed
$registeredDomains  : mixed
$requestInterval  : mixed
$state  : mixed
$staticModules  : mixed
$upgradeUrl  : mixed
$validTo  : mixed
$version  : mixed

Methods

__construct()  : mixed
Create a License
check()  : mixed
checkSum()  : mixed
getAvailableComponents()  : mixed
getCached()  : License
getCreatedAtDate()  : mixed
getCustomer()  : mixed
getDashboardMessages()  : mixed
getEditionName()  : mixed
getFirstFailedUpdateTime()  : mixed
getFrontendLockTime()  : mixed
getGrayzoneMessage()  : Message
getGrayzoneMessages()  : mixed
getGrayzoneTime()  : mixed
getInstallationId()  : mixed
getIsUpgradable()  : mixed
getLastSuccessfulUpdateTime()  : mixed
getLegalComponentsAdditionalData()  : array<string|int, mixed>
get the legal components additional data
getLegalComponentsList()  : mixed
getLegalFrontendComponentsList()  : mixed
getLicensedComponentsWithAdditionalData()  : array<string|int, mixed>
Get the licensed components with their additional data's
getLicenseKey()  : mixed
getMessage()  : Message
getMessages()  : mixed
getPartner()  : mixed
getRegisteredDomains()  : mixed
getRequestInterval()  : mixed
getState()  : mixed
getUpgradeUrl()  : mixed
getValidToDate()  : mixed
getVersion()  : Version
isFrontendLocked()  : mixed
isInLegalComponents()  : mixed
isInLegalFrontendComponents()  : mixed
isUpgradable()  : mixed
loadComponentsAdditionalData()  : mixed
Load the component's addtional data from the argument $legalComponents
save()  : mixed
setAvailableComponents()  : mixed
setCreatedAtDate()  : mixed
setDashboardMessages()  : mixed
setEditionName()  : mixed
setFirstFailedUpdateTime()  : mixed
setFrontendLockTime()  : mixed
setGrayZoneMessages()  : mixed
setGrayzoneTime()  : mixed
setInstallationId()  : mixed
setIsUpgradable()  : mixed
setLastSuccessfulUpdateTime()  : mixed
setLegalComponents()  : mixed
setLegalComponentsAdditionalData()  : mixed
Set the legal Components additional data
setLicenseKey()  : mixed
setMessages()  : mixed
setRegisteredDomains()  : mixed
setRequestInterval()  : mixed
setState()  : mixed
setUpdateInterval()  : mixed
setUpgradeUrl()  : mixed
setValidToDate()  : mixed
decodeData()  : mixed
Returns the unserialized, decoded special-charachters & base64 encoded string $data.
getMessageInPreferedLanguage()  : mixed
Select the prefered locale version of a message

Constants

Properties

$lastSuccessfulUpdate

private mixed $lastSuccessfulUpdate = 0

$legalComponentsAdditionalData

private mixed $legalComponentsAdditionalData = array()

$legalFrontendComponents

private mixed $legalFrontendComponents

$registeredDomains

private mixed $registeredDomains = array()

$staticModules

private static mixed $staticModules = array('license', 'logout', 'Error', 'Captcha', 'upgrade', 'noaccess', 'fulllanguage')

Methods

__construct()

Create a License

public __construct([string $state = self::LICENSE_DEMO ][, string $editionName = '' ][, array<string|int, mixed> $availableComponents = array() ][, array<string|int, mixed> $legalComponents = array() ][, string $validTo = '' ][, string $createdAt = '' ][, array<string|int, mixed> $registeredDomains = array() ][, string $instId = '' ][, string $licenseKey = '' ][, array<string|int, mixed> $messages = array() ][, string $version = '' ][, Person $partner = null ][, Person $customer = null ][, int $grayzoneTime = 14 ][, array<string|int, mixed> $grayzoneMessages = array() ][, int $frontendLockTime = 10 ][, int $requestInterval = 1 ][, int $firstFailedUpdate = 0 ][, int $lastSuccessfulUpdate = 0 ][, string $upgradeUrl = '' ][, bool $isUpgradable = false ][, array<string|int, mixed> $dashboardMessages = [] ]) : mixed
Parameters
$state : string = self::LICENSE_DEMO
$editionName : string = ''
$availableComponents : array<string|int, mixed> = array()
$legalComponents : array<string|int, mixed> = array()
$validTo : string = ''
$createdAt : string = ''
$registeredDomains : array<string|int, mixed> = array()
$instId : string = ''
$licenseKey : string = ''
$messages : array<string|int, mixed> = array()
$version : string = ''
$partner : Person = null
$customer : Person = null
$grayzoneTime : int = 14
$grayzoneMessages : array<string|int, mixed> = array()
$frontendLockTime : int = 10
$requestInterval : int = 1
$firstFailedUpdate : int = 0
$lastSuccessfulUpdate : int = 0
$upgradeUrl : string = ''
$isUpgradable : bool = false
$dashboardMessages : array<string|int, mixed> = []

checkSum()

public checkSum(mixed $key[, mixed $id = true ]) : mixed
Parameters
$key : mixed
$id : mixed = true

getAvailableComponents()

public getAvailableComponents() : mixed

getCached()

public static getCached(array<string|int, mixed> &$_CONFIG, ADONewConnection $objDb) : License
Parameters
$_CONFIG : array<string|int, mixed>

Reference to the basic settings ($_CONFIG)

$objDb : ADONewConnection

Database connection object

Return values
License

getDashboardMessages()

public getDashboardMessages() : mixed

getFirstFailedUpdateTime()

public getFirstFailedUpdateTime() : mixed

getGrayzoneMessage()

public getGrayzoneMessage(mixed $langCode, mixed $_CORELANG) : Message
Parameters
$langCode : mixed
$_CORELANG : mixed
Return values
Message

getLastSuccessfulUpdateTime()

public getLastSuccessfulUpdateTime() : mixed

getLegalComponentsAdditionalData()

get the legal components additional data

public getLegalComponentsAdditionalData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLegalComponentsList()

public getLegalComponentsList() : mixed

getLegalFrontendComponentsList()

public getLegalFrontendComponentsList() : mixed

getLicensedComponentsWithAdditionalData()

Get the licensed components with their additional data's

public getLicensedComponentsWithAdditionalData() : array<string|int, mixed>
Tags
global

type $objDatabase

Return values
array<string|int, mixed>

getMessage()

public getMessage(mixed $dashboard, mixed $langCode, mixed $_CORELANG) : Message
Parameters
$dashboard : mixed
$langCode : mixed
$_CORELANG : mixed
Return values
Message

getRegisteredDomains()

public getRegisteredDomains() : mixed

isInLegalComponents()

public isInLegalComponents(mixed $componentName) : mixed
Parameters
$componentName : mixed

isInLegalFrontendComponents()

public isInLegalFrontendComponents(mixed $componentName) : mixed
Parameters
$componentName : mixed

loadComponentsAdditionalData()

Load the component's addtional data from the argument $legalComponents

public loadComponentsAdditionalData([array<string|int, mixed> $legalComponents = array() ]) : mixed
Parameters
$legalComponents : array<string|int, mixed> = array()
Return values
mixed —

array | boolean

save()

public save(ADONewConnection $objDb) : mixed
Parameters
$objDb : ADONewConnection
Tags
global

type $_POST

setAvailableComponents()

public setAvailableComponents(mixed $availableComponents) : mixed
Parameters
$availableComponents : mixed

setCreatedAtDate()

public setCreatedAtDate(mixed $createdAt) : mixed
Parameters
$createdAt : mixed

setDashboardMessages()

public setDashboardMessages(mixed $dashboardMessages) : mixed
Parameters
$dashboardMessages : mixed

setEditionName()

public setEditionName(mixed $editionName) : mixed
Parameters
$editionName : mixed

setFirstFailedUpdateTime()

public setFirstFailedUpdateTime(mixed $time) : mixed
Parameters
$time : mixed

setFrontendLockTime()

public setFrontendLockTime(mixed $frontendLockTime) : mixed
Parameters
$frontendLockTime : mixed

setGrayZoneMessages()

public setGrayZoneMessages(mixed $grayzoneMessages) : mixed
Parameters
$grayzoneMessages : mixed

setGrayzoneTime()

public setGrayzoneTime(mixed $grayzoneTime) : mixed
Parameters
$grayzoneTime : mixed

setInstallationId()

public setInstallationId(mixed $insId) : mixed
Parameters
$insId : mixed

setIsUpgradable()

public setIsUpgradable(mixed $isUpgradable) : mixed
Parameters
$isUpgradable : mixed

setLastSuccessfulUpdateTime()

public setLastSuccessfulUpdateTime(mixed $time) : mixed
Parameters
$time : mixed

setLegalComponents()

public setLegalComponents(mixed $legalComponents) : mixed
Parameters
$legalComponents : mixed

setLegalComponentsAdditionalData()

Set the legal Components additional data

public setLegalComponentsAdditionalData(array<string|int, mixed> $legalComponentsAdditionalData) : mixed
Parameters
$legalComponentsAdditionalData : array<string|int, mixed>

setLicenseKey()

public setLicenseKey(mixed $key) : mixed
Parameters
$key : mixed

setMessages()

public setMessages(mixed $messages) : mixed
Parameters
$messages : mixed

setRegisteredDomains()

public setRegisteredDomains(mixed $registeredDomains) : mixed
Parameters
$registeredDomains : mixed

setRequestInterval()

public setRequestInterval(mixed $requestInterval) : mixed
Parameters
$requestInterval : mixed

setState()

public setState(mixed $state) : mixed
Parameters
$state : mixed

setUpdateInterval()

public setUpdateInterval(mixed $requestInterval) : mixed
Parameters
$requestInterval : mixed

setUpgradeUrl()

public setUpgradeUrl(mixed $upgradeUrl) : mixed
Parameters
$upgradeUrl : mixed

setValidToDate()

public setValidToDate(mixed $timestamp) : mixed
Parameters
$timestamp : mixed

decodeData()

Returns the unserialized, decoded special-charachters & base64 encoded string $data.

protected static decodeData(string $data[, string $unserializeClass = '' ]) : mixed
Parameters
$data : string

Serialize data

$unserializeClass : string = ''
Return values
mixed —

Unserialized data

getMessageInPreferedLanguage()

Select the prefered locale version of a message

private getMessageInPreferedLanguage(mixed $messages, mixed $langCode) : mixed
Parameters
$messages : mixed
$langCode : mixed
Return values
mixed —

Either the prefered message as string or NULL if $messages is empty


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results