Documentation

Consent extends AbstractConsent

in package

• Application

implements IOverrideConsent Uses Consent, UtilsProvider

Settings > Consent.

Table of Contents

Interfaces

IOverrideConsent

Constants

AGE_NOTICE_COUNTRY_AGE_MAP  = ['INHERIT' => 0, 'GDPR' => 16, 'BE' => 13, 'DK' => 13, 'EE' => 13, 'FI' => 13, 'IS' => 13, 'LV' => 13, 'NO' => 13, 'PT' => 13, 'SE' => 13, 'MT' => 13, 'AT' => 14, 'BG' => 14, 'CY' => 14, 'IT' => 14, 'LT' => 14, 'ES' => 14, 'CZ' => 15, 'FR' => 15, 'GR' => 15, 'SI' => 15, 'DE' => 16, 'HR' => 16, 'HU' => 16, 'LI' => 16, 'LU' => 16, 'NL' => 16, 'PL' => 16, 'RO' => 16, 'SK' => 16, 'IE' => 16, 'CH' => 13]

COOKIE_VERSION_1  = 1

Search the coding for difference.

COOKIE_VERSION_2  = 2

COOKIE_VERSION_3  = 3

CUSTOM_BYPASS_BANNER_LESS_CONSENT  = 'bannerless'

DEFAULT_ACCEPT_ALL_FOR_BOTS  = true

DEFAULT_AGE_NOTICE  = true

DEFAULT_AGE_NOTICE_AGE_LIMIT  = 'INHERIT'

DEFAULT_BANNER_LESS_CONSENT  = false

DEFAULT_BANNER_LESS_SHOW_ON_PAGE_IDS  = ''

DEFAULT_CONSENT_DURATION  = 120

DEFAULT_COOKIE_DURATION  = 365

DEFAULT_COOKIE_VERSION  = self::COOKIE_VERSION_3

DEFAULT_DATA_PROCESSING_IN_UNSAFE_COUNTRIES  = false

DEFAULT_FAILED_CONSENT_DOCUMENTATION_HANDLING  = self::FAILED_CONSENT_DOCUMENTATION_HANDLING_ESSENTIALS_ONLY

DEFAULT_LIST_SERVICES_NOTICE  = true

DEFAULT_RESPECT_DO_NOT_TRACK  = false

DEFAULT_SAVE_IP  = false

FAILED_CONSENT_DOCUMENTATION_HANDLING_ESSENTIALS_ONLY  = 'essentials'

FAILED_CONSENT_DOCUMENTATION_HANDLING_OPTIMISTIC  = 'optimistic'

FAILED_CONSENT_DOCUMENTATION_HANDLINGS  = [self::FAILED_CONSENT_DOCUMENTATION_HANDLING_OPTIMISTIC, self::FAILED_CONSENT_DOCUMENTATION_HANDLING_ESSENTIALS_ONLY]

OPTION_GROUP  = 'options'

PREDEFINED_DATA_PROCESSING_IN_SAFE_COUNTRIES_LISTS  = [ // EU: https://reciprocitylabs.com/resources/what-countries-are-covered-by-gdpr/ // EEA: https://ec.europa.eu/eurostat/statistics-explained/index.php?title=Glossary:European_Economic_Area_(EEA) 'GDPR' => ['AT', 'BE', 'BG', 'HR', 'CY', 'CZ', 'DK', 'EE', 'FI', 'FR', 'DE', 'GR', 'HU', 'IE', 'IS', 'IT', 'LI', 'LV', 'LT', 'LU', 'MT', 'NL', 'NO', 'PL', 'PT', 'RO', 'SK', 'SI', 'ES', 'SE'], 'DSG' => ['CH'], 'GDPR+DSG' => [], 'ADEQUACY_EU' => ['AD', 'AR', 'CA', 'FO', 'GG', 'IL', 'IM', 'JP', 'JE', 'NZ', 'KR', 'CH', 'GB', 'UY', 'US'], 'ADEQUACY_CH' => ['DE', 'AD', 'AR', 'AT', 'BE', 'BG', 'CA', 'CY', 'HR', 'DK', 'ES', 'EE', 'FI', 'FR', 'GI', 'GR', 'GG', 'HU', 'IM', 'FO', 'IE', 'IS', 'IL', 'IT', 'JE', 'LV', 'LI', 'LT', 'LU', 'MT', 'MC', 'NO', 'NZ', 'NL', 'PL', 'PT', 'CZ', 'RO', 'GB', 'SK', 'SI', 'SE', 'UY', 'US'], ]

A list of predefined lists for e.g. `GDPR` considered as secury country for data processing in unsafe countries.

SETTING_ACCEPT_ALL_FOR_BOTS  = RCB_OPT_PREFIX . '-accept-all-for-bots'

SETTING_AGE_NOTICE  = RCB_OPT_PREFIX . '-age-notice'

SETTING_AGE_NOTICE_AGE_LIMIT  = RCB_OPT_PREFIX . '-age-notice-age-limit'

SETTING_BANNER_LESS_CONSENT  = RCB_OPT_PREFIX . '-banner-less-consent'

SETTING_BANNER_LESS_SHOW_ON_PAGE_IDS  = RCB_OPT_PREFIX . '-banner-less-show-on-page-ids'

SETTING_CONSENT_DURATION  = RCB_OPT_PREFIX . '-consent-duration'

SETTING_COOKIE_DURATION  = RCB_OPT_PREFIX . '-cookie-duration'

SETTING_COOKIE_VERSION  = RCB_OPT_PREFIX . '-cookie-version'

SETTING_DATA_PROCESSING_IN_UNSAFE_COUNTRIES  = RCB_OPT_PREFIX . '-data-processing-in-unsafe-countries'

SETTING_FAILED_CONSENT_DOCUMENTATION_HANDLING  = RCB_OPT_PREFIX . '-failed-consent-documentation-handling'

SETTING_LIST_SERVICES_NOTICE  = RCB_OPT_PREFIX . '-list-services-notice'

SETTING_RESPECT_DO_NOT_TRACK  = RCB_OPT_PREFIX . '-respect-do-not-track'

SETTING_SAVE_IP  = RCB_OPT_PREFIX . '-save-ip'

TRANSIENT_SCHEDULE_CONSENTS_DELETION  = RCB_OPT_PREFIX . '-schedule-consents-deletion'

Properties

$me  : Consent

Singleton instance.

$settings  : Settings

See Settings

Methods

calculateBannerlessConsentChecks()  : array<string|int, mixed>

Calculate if the bannerless consent check should be enabled.

calculateServicesWithDataProcessingInUnsafeCountries()  : mixed

Calculate configured services which are processing data in unsafe countries.

dynamicPredecision()  : mixed

Determines, if the current page request should be bypassed by bannerless mode.

enableOptionsAutoload()  : mixed

Initially `add_option` to avoid autoloading issues.

getAgeNoticeAgeLimit()  : int

Get the configured age limit for the age notice.

getAgeNoticeAgeLimitRaw()  : string|int

Get the configured age limit for the age notice in raw format.

getBannerLessConsentShowOnPageIds()  : array<string|int, int>

Get the page IDs where the banner less consent should be shown.

getConsentDuration()  : int

Get the consent duration in months.

getCookieDuration()  : int

Get the cookie duration for the consent cookies in days.

getCookieVersion()  : int

Get the cookie version for the consent cookies.

getFailedConsentDocumentationHandling()  : string

Get the behavior what should be done when documentating the consent fails. See als `FAILED_CONSENT_HANDLINGS`.

getInstance()  : mixed

Get singleton instance.

getPluginConstantPrefix()  : string

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

getSettings()  : mixed

Getter.

isAcceptAllForBots()  : bool

Check if bots should acceppt all cookies automatically.

isAgeNoticeEnabled()  : bool

Check if age notice hint is enabled

isBannerLessConsent()  : bool

Check if banner less consent is enabled.

isDataProcessingInUnsafeCountries()  : bool

Check if data processing in unsafe countries is enabled.

isListServicesNoticeEnabled()  : bool

Check if list-services notice hint is enabled

isRespectDoNotTrack()  : bool

Check if "Do not Track" header is respected.

isSaveIpEnabled()  : bool

Check if IPs should be saved in plain in database.

option_consent_duration()  : mixed

The consent duration may not be greater than 120 months.

option_cookie_duration()  : mixed

The cookie duration may not be greater than 365 days.

overrideEnableOptionsAutoload()  : mixed

overrideRegister()  : mixed

probablyCreateBannerlessConsentTransaction()  : mixed

If bannerless consent is enabled, we can create a transaction which we can instantly use to `Consent#commit` so the user does not see any cookie banner.

register()  : mixed

Register settings.

setCookieVersion()  : mixed

Set the cookie version for the consent cookies.

setSettings()  : mixed

Setter.

update_option_consent_transient_deletion()  : mixed

Delete transient when settings are updated

__construct()  : mixed

C'tor.