Documentation

Multisite extends AbstractMultisite
in package
implements IOverrideMultisite uses Multisite, UtilsProvider

Consent Forwarding settings.

Table of Contents

Interfaces

IOverrideMultisite

Constants

ALL_ENDPOINT_FILTERS  = [self::ENDPOINT_FILTER_ALL, self::ENDPOINT_FILTER_NOT_CURRENT, self::ENDPOINT_FILTER_ONLY_CURRENT]
DEFAULT_CONSENT_FORWARDING  = false
DEFAULT_CROSS_DOMAINS  = ''
DEFAULT_FORWARD_TO  = ''
ENDPOINT_FILTER_ALL  = 'all'
ENDPOINT_FILTER_NOT_CURRENT  = 'notCurrent'
ENDPOINT_FILTER_ONLY_CURRENT  = 'onlyCurrent'
FORWARDING_QUERY_BLOG_ID  = 'blog'
OPTION_GROUP  = 'options'
SETTING_CONSENT_FORWARDING  = RCB_OPT_PREFIX . '-consent-forwarding'
SETTING_CROSS_DOMAINS  = RCB_OPT_PREFIX . '-cross-domains'
SETTING_FORWARD_TO  = RCB_OPT_PREFIX . '-forward-to'

Properties

$me  : Multisite
Singleton instance.

Methods

enableOptionsAutoload()  : mixed
Initially `add_option` to avoid autoloading issues.
getAvailableEndpoints()  : mixed
getConfiguredEndpoints()  : mixed
getCrossDomains()  : mixed
getEnvironmentHost()  : string
Get current host for the current environment where consent is processed.
getExternalHosts()  : array<string|int, string>
Check if external hosts need to be contacted and return the external hosts including subdomain.
getForwardTo()  : mixed
getInstance()  : Multisite
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.
isConsentForwarding()  : mixed
mapDecisionToUniqueNames()  : array<string|int, string>
Transform a given consent decision (groups with service IDs) to a map of unique names.
mapUniqueNamesToDecision()  : mixed
Transform a given consent decision in string[] (`uniqueName`) to a map of groups with cookie ids.
overrideEnableOptionsAutoload()  : mixed
overrideRegister()  : mixed
register()  : mixed
Register settings.
setSettings()  : mixed
Setter.
updated_option_forward_to()  : mixed
The option "Forward to" got updated. Let's iterate all available sites and activate consent forwarding automatically.
__construct()  : mixed
C'tor.

Constants

ALL_ENDPOINT_FILTERS

public mixed ALL_ENDPOINT_FILTERS = [self::ENDPOINT_FILTER_ALL, self::ENDPOINT_FILTER_NOT_CURRENT, self::ENDPOINT_FILTER_ONLY_CURRENT]
public mixed DEFAULT_CONSENT_FORWARDING = false

DEFAULT_CROSS_DOMAINS

public mixed DEFAULT_CROSS_DOMAINS = ''

DEFAULT_FORWARD_TO

public mixed DEFAULT_FORWARD_TO = ''

ENDPOINT_FILTER_NOT_CURRENT

public mixed ENDPOINT_FILTER_NOT_CURRENT = 'notCurrent'

ENDPOINT_FILTER_ONLY_CURRENT

public mixed ENDPOINT_FILTER_ONLY_CURRENT = 'onlyCurrent'

FORWARDING_QUERY_BLOG_ID

public mixed FORWARDING_QUERY_BLOG_ID = 'blog'

OPTION_GROUP

public mixed OPTION_GROUP = 'options'
public mixed SETTING_CONSENT_FORWARDING = RCB_OPT_PREFIX . '-consent-forwarding'

SETTING_CROSS_DOMAINS

public mixed SETTING_CROSS_DOMAINS = RCB_OPT_PREFIX . '-cross-domains'

SETTING_FORWARD_TO

public mixed SETTING_FORWARD_TO = RCB_OPT_PREFIX . '-forward-to'

Properties

Methods

enableOptionsAutoload()

Initially `add_option` to avoid autoloading issues.

public enableOptionsAutoload() : mixed

getConfiguredEndpoints()

public getConfiguredEndpoints() : mixed

getCrossDomains()

public getCrossDomains() : mixed

getEnvironmentHost()

Get current host for the current environment where consent is processed.

public getEnvironmentHost() : string
Return values
string

getExternalHosts()

Check if external hosts need to be contacted and return the external hosts including subdomain.

public getExternalHosts() : array<string|int, string>

Returns false if no external host gets contacted.

Return values
array<string|int, string>

getForwardTo()

public getForwardTo() : mixed

getPluginConstantPrefix()

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

public getPluginConstantPrefix() : string
Tags
codeCoverageIgnore

It only returns a string with the constant prefix

Return values
string

getSettings()

Getter.

public getSettings() : mixed
Tags
codeCoverageIgnore

isConsentForwarding()

public isConsentForwarding() : mixed

mapDecisionToUniqueNames()

Transform a given consent decision (groups with service IDs) to a map of unique names.

public mapDecisionToUniqueNames(array<string|int, mixed> $decision) : array<string|int, string>
Parameters
$decision : array<string|int, mixed>
Return values
array<string|int, string>

mapUniqueNamesToDecision()

Transform a given consent decision in string[] (`uniqueName`) to a map of groups with cookie ids.

public mapUniqueNamesToDecision(array<string|int, string> $uniqueNames) : mixed

It automatically accepts all essential services.

Parameters
$uniqueNames : array<string|int, string>

overrideEnableOptionsAutoload()

public overrideEnableOptionsAutoload() : mixed

overrideRegister()

public overrideRegister() : mixed

register()

Register settings.

public register() : mixed

updated_option_forward_to()

The option "Forward to" got updated. Let's iterate all available sites and activate consent forwarding automatically.

public updated_option_forward_to(string $option) : mixed
Parameters
$option : string

Name of the updated option

__construct()

C'tor.

private __construct() : mixed

        
On this page

Search results