CoolCMS API

ConsentGate extends BaseComponent
in package
uses SignalTrait

Table of Contents

Constants

SESSION_SECTION  : mixed = 'consent'

Properties

$container  : Container
$routerDispatcher  : RouterDispatcher
$translator  : ITranslator
$appContext  : AppContext
$componentParameters  : array<string, mixed>
$currencyContext  : CurrencyContext|null
$declineFallbackUrl  : string
$deviceDetector  : DeviceDetector|null
$expiration  : DateTimeInterface|null
$httpRequest  : IRequest
$languageContext  : LanguageContext|null
$localizationContext  : LocalizationContext|null
$session  : Session
$sessionKey  : string
$settingContext  : SettingContext
$text  : string
$themeContext  : ThemeContext|null
$translatorDomain  : string|null

Methods

__call()  : mixed
Dispatches `renderXyz()` to `render('Xyz', ...$args)`.
__construct()  : mixed
createComponent()  : IComponent|null
getAppContext()  : AppContext
getComponentParameter()  : mixed
Returns a component parameter, or null when it is not set.
getContainer()  : Container
getCurrencyContext()  : CurrencyContext|null
getLanguageContext()  : LanguageContext|null
getLocalizationContext()  : LocalizationContext|null
getRouterDispatcher()  : RouterDispatcher
getSettingContext()  : SettingContext
getSettings()  : array<int, array<string, mixed>>
getThemeContext()  : ThemeContext|null
handleConsent()  : void
handleDecline()  : void
hasConsent()  : bool
hasServiceByType()  : bool
Returns whether the container has a service of the given type.
init()  : self
initializeAllContexts()  : void
injectDeviceDetector()  : void
onCreate()  : void
render()  : void
setAppContext()  : $this
setComponentParameter()  : void
Sets a component parameter.
setCurrencyContext()  : $this
setLanguageContext()  : $this
setLocalizationContext()  : $this
setSettingContext()  : $this
setThemeContext()  : $this
setup()  : void
setupAppContext()  : void
typedComponent()  : T
Returns a subcomponent with a verified type.
frontPresenter()  : BasePresenter|null
Returns the front presenter the component is attached to (null outside the front end or when detached).
getSection()  : SessionSection
getTranslator()  : ITranslator
resolveBackUrl()  : string
setTemplateFile()  : void
setTranslator()  : self
createMultiplierComponent()  : Multiplier<string|int, IComponent>
Creates a multiplier for the component.
createNewComponentInstance()  : IComponent|null
Creates a new component instance without adding it to the presenter; used by the multiplier.
createStandardComponent()  : IComponent|null
Creates a standard component (not a multiplier).
isSameHostUrl()  : bool
sanitizeKey()  : string

Constants

SESSION_SECTION

private mixed SESSION_SECTION = 'consent'

Properties

$componentParameters

protected array<string, mixed> $componentParameters = []

component parameters set by setComponentParameter()

$declineFallbackUrl

protected string $declineFallbackUrl = '/'

$expiration

protected DateTimeInterface|null $expiration = null

$httpRequest read-only

protected IRequest $httpRequest

$sessionKey

protected string $sessionKey = 'default'

$translatorDomain

protected string|null $translatorDomain = 'front.base.components.consentGate'

Methods

__call()

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

public __call(string $name, array<string|int, mixed> $args) : mixed

Called only when the component has no renderXyz() method of its own.

Parameters
$name : string
$args : array<string|int, mixed>

__construct()

public __construct(Session $session, IRequest $httpRequest) : mixed
Parameters
$session : Session
$httpRequest : IRequest

createComponent()

public createComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

getComponentParameter()

Returns a component parameter, or null when it is not set.

public getComponentParameter(string $name) : mixed
Parameters
$name : string

getContainer()

public getContainer() : Container
Return values
Container

getSettings()

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

handleDecline()

public handleDecline([string $backUrl = '' ]) : void
Parameters
$backUrl : string = ''

hasConsent()

public hasConsent() : bool
Return values
bool

hasServiceByType()

Returns whether the container has a service of the given type.

public hasServiceByType(string $className) : bool

The name is composed dynamically (module plus component), so class_exists() runs first, and a true result guarantees a valid type.

Parameters
$className : string
Tags
phpstan-assert-if-true

class-string $className

Return values
bool

init()

public init(string $text, string $sessionKey[, DateTimeInterface|null $expiration = null ][, string $declineFallbackUrl = '/' ]) : self
Parameters
$text : string
$sessionKey : string
$expiration : DateTimeInterface|null = null
$declineFallbackUrl : string = '/'
Return values
self

setComponentParameter()

Sets a component parameter.

public setComponentParameter(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

typedComponent()

Returns a subcomponent with a verified type.

public typedComponent(string $name, T> $type) : T

Use it instead of an inline @var above $this['x'] (which does not narrow the type) and instead of the generic IComponent that $this['x'] returns. See Form::typedComponent().

Parameters
$name : string
$type : T>
Tags
template
Return values
T

frontPresenter()

Returns the front presenter the component is attached to (null outside the front end or when detached).

protected frontPresenter() : BasePresenter|null
Return values
BasePresenter|null

getSection()

protected getSection() : SessionSection
Return values
SessionSection

getTranslator()

protected getTranslator() : ITranslator
Return values
ITranslator

resolveBackUrl()

protected resolveBackUrl() : string
Return values
string

setTemplateFile()

protected setTemplateFile(string $dir, string $filename) : void
Parameters
$dir : string
$filename : string

setTranslator()

protected setTranslator(ITranslator $translator) : self
Parameters
$translator : ITranslator
Return values
self

createMultiplierComponent()

Creates a multiplier for the component.

private createMultiplierComponent(string $name) : Multiplier<string|int, IComponent>
Parameters
$name : string
Return values
Multiplier<string|int, IComponent>

createNewComponentInstance()

Creates a new component instance without adding it to the presenter; used by the multiplier.

private createNewComponentInstance(string $baseName[, int|string|null $uniqueKey = null ]) : IComponent|null
Parameters
$baseName : string
$uniqueKey : int|string|null = null
Return values
IComponent|null

createStandardComponent()

Creates a standard component (not a multiplier).

private createStandardComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

isSameHostUrl()

private isSameHostUrl(string $url) : bool
Parameters
$url : string
Return values
bool

sanitizeKey()

private sanitizeKey(string $key) : string
Parameters
$key : string
Return values
string
On this page

Search results