Documentation

AbstractGeneral extends BaseSettings
in package

AbstractYes

Abstract implementation of the settings for general consent management (e.g. is cookie banner active?).

Table of Contents

Constants

LEGAL_BASIS_ALLOWED  = [self::TERRITORIAL_LEGAL_BASIS_GDPR, self::TERRITORIAL_LEGAL_BASIS_DSG_SWITZERLAND]
TERRITORIAL_LEGAL_BASIS_DSG_SWITZERLAND  = 'dsg-switzerland'
TERRITORIAL_LEGAL_BASIS_GDPR  = 'gdpr-eprivacy'

Properties

$settings  : Settings
See Settings

Methods

getAdditionalPageHideIds()  : array<string|int, int>
Get an array of hidden page ids (not imprint and privacy policy, there are own options!).
getBannerLinks()  : array<string|int, BannerLink>
Get the list of banner links which should be shown in cookie banner and content blocker.
getBlocker()  : array<string|int, Blocker>
Get the list of content blockers.
getCookiePolicyId()  : int
Get the cookie policy page ID.
getCookiePolicyUrl()  : mixed
Get the cookie policy page URL.
getEssentialServiceGroup()  : mixed
Get the essential service groups.
getLanguages()  : array<string|int, Language>
Get the list of languages in which this website is reachable. This is also used for the language switcher.
getNonDefaultServiceGroups()  : array<string|int, ServiceGroup>
Get the list of service groups and their services which are not created by default (custom groups).
getOperatorContactAddress()  : string
Get configured operator contact address.
getOperatorContactEmail()  : string
Get configured operator contact email.
getOperatorContactFormId()  : int
Get the operator contact form page ID.
getOperatorContactFormUrl()  : mixed
Get the operator contact form page URL.
getOperatorContactPhone()  : string
Get configured operator contact phone.
getOperatorCountry()  : string
Get configured operator country.
getServiceGroups()  : array<string|int, ServiceGroup>
Get the list of service groups and their services.
getSetCookiesViaManager()  : string
Get the option "Load services after consent via".
getSettings()  : mixed
Getter.
getTerritorialLegalBasis()  : array<string|int, string>
Get configured legal basis.
isBannerActive()  : bool
Is the banner active?
isBlockerActive()  : bool
Is the content blocker active?
setSettings()  : mixed
Setter.

Constants

public mixed LEGAL_BASIS_ALLOWED = [self::TERRITORIAL_LEGAL_BASIS_GDPR, self::TERRITORIAL_LEGAL_BASIS_DSG_SWITZERLAND]
public mixed TERRITORIAL_LEGAL_BASIS_DSG_SWITZERLAND = 'dsg-switzerland'
public mixed TERRITORIAL_LEGAL_BASIS_GDPR = 'gdpr-eprivacy'

Properties

Methods

getAdditionalPageHideIds()

Get an array of hidden page ids (not imprint and privacy policy, there are own options!).

public abstract getAdditionalPageHideIds() : array<string|int, int>
Return values
array<string|int, int>

Get the list of banner links which should be shown in cookie banner and content blocker.

public abstract getBannerLinks() : array<string|int, BannerLink>
Return values
array<string|int, BannerLink>

getBlocker()

Get the list of content blockers.

public abstract getBlocker() : array<string|int, Blocker>
Return values
array<string|int, Blocker>

getCookiePolicyId()

Get the cookie policy page ID.

public abstract getCookiePolicyId() : int
Return values
int

getCookiePolicyUrl()

Get the cookie policy page URL.

public abstract getCookiePolicyUrl([mixed $default = false ]) : mixed
Parameters
$default : mixed = false

getEssentialServiceGroup()

Get the essential service groups.

public getEssentialServiceGroup() : mixed

getLanguages()

Get the list of languages in which this website is reachable. This is also used for the language switcher.

public abstract getLanguages() : array<string|int, Language>
Return values
array<string|int, Language>

getNonDefaultServiceGroups()

Get the list of service groups and their services which are not created by default (custom groups).

public getNonDefaultServiceGroups() : array<string|int, ServiceGroup>
Return values
array<string|int, ServiceGroup>

getOperatorContactAddress()

Get configured operator contact address.

public abstract getOperatorContactAddress() : string
Return values
string

getOperatorContactEmail()

Get configured operator contact email.

public abstract getOperatorContactEmail() : string
Return values
string

getOperatorContactFormId()

Get the operator contact form page ID.

public abstract getOperatorContactFormId() : int
Return values
int

getOperatorContactFormUrl()

Get the operator contact form page URL.

public abstract getOperatorContactFormUrl([mixed $default = false ]) : mixed
Parameters
$default : mixed = false

getOperatorContactPhone()

Get configured operator contact phone.

public abstract getOperatorContactPhone() : string
Return values
string

getOperatorCountry()

Get configured operator country.

public abstract getOperatorCountry() : string
Return values
string

getSetCookiesViaManager()

Get the option "Load services after consent via".

public abstract getSetCookiesViaManager() : string
Return values
string

getSettings()

Getter.

public getSettings() : mixed
Tags
codeCoverageIgnore

getTerritorialLegalBasis()

Get configured legal basis.

public abstract getTerritorialLegalBasis() : array<string|int, string>
Return values
array<string|int, string>

isBannerActive()

Is the banner active?

public abstract isBannerActive() : bool
Return values
bool

isBlockerActive()

Is the content blocker active?

public abstract isBlockerActive() : bool
Return values
bool

        
On this page

Search results