Documentation

AbstractTcf extends BaseSettings
in package

AbstractYes

Abstract implementation of the settings for the TCF compatibility.

Table of Contents

Constants

ALLOWED_SCOPE_OF_CONSENT  : mixed = [self::SCOPE_OF_CONSENT_SERVICE]
SCOPE_OF_CONSENT_SERVICE  : mixed = 'service-specific'

Methods

fourLetterLanguageCodeToTwoLetterCode()  : mixed
Sanitize a 4-letter language code to 2-letter language code as it is the only one which is currently supported by TCF.
getCookiePolicyVendorDisclosures()  : iterable<string|int, array{name: string, disclosures: array}>
Vendor name + device-storage disclosures for the cookie-policy services table.
getGvl()  : AbstractGvlPersistance
Get GVL persistence class.
getNextUpdateTime()  : mixed
Changes to the Global Vendor List are published weekly at 5:00 PM Central European Time on Thursdays.
getScopeOfConsent()  : string
Get scope of consent.
getSettings()  : mixed
Getter.
getVendorConfigurations()  : array<string|int, VendorConfiguration>
Get the list of created TCF vendor configurations.
hasVendorConfigurations()  : bool
Whether at least one TCF vendor configuration exists. Default hydrates GVL vendors; persistences that can answer this from configuration records should override.
isActive()  : bool
Check if compatibility is enabled.
setSettings()  : mixed
Setter.

Constants

public mixed ALLOWED_SCOPE_OF_CONSENT = [self::SCOPE_OF_CONSENT_SERVICE]
public mixed SCOPE_OF_CONSENT_SERVICE = 'service-specific'

Methods

fourLetterLanguageCodeToTwoLetterCode()

Sanitize a 4-letter language code to 2-letter language code as it is the only one which is currently supported by TCF.

public static fourLetterLanguageCodeToTwoLetterCode(string $language) : mixed
Parameters
$language : string

getCookiePolicyVendorDisclosures()

Vendor name + device-storage disclosures for the cookie-policy services table.

public getCookiePolicyVendorDisclosures() : iterable<string|int, array{name: string, disclosures: array}>

Default hydrates full vendor configurations; persistences should override with a lean query.

Return values
iterable<string|int, array{name: string, disclosures: array}>

getNextUpdateTime()

Changes to the Global Vendor List are published weekly at 5:00 PM Central European Time on Thursdays.

public static getNextUpdateTime() : mixed

To spread the load to our backend server we add a random amount of minutes between 15 and 60 minutes. Why skip 0-15? The cronjob which creates the GVL starts to run at 5:00 PM Central European Time and takes about 10 minutes to complete.

getScopeOfConsent()

Get scope of consent.

public abstract getScopeOfConsent() : string
Return values
string

Can be service

getSettings()

Getter.

public getSettings() : mixed
Tags
codeCoverageIgnore

hasVendorConfigurations()

Whether at least one TCF vendor configuration exists. Default hydrates GVL vendors; persistences that can answer this from configuration records should override.

public hasVendorConfigurations() : bool
Return values
bool

isActive()

Check if compatibility is enabled.

public abstract isActive() : bool
Return values
bool
On this page

Search results