Documentation

AbstractMultisite extends BaseSettings

in package

• Application

Abstract implementation of the settings for a multisite network (Consent Forwarding).

Table of Contents

Constants

ALL_ENDPOINT_FILTERS  = [self::ENDPOINT_FILTER_ALL, self::ENDPOINT_FILTER_NOT_CURRENT, self::ENDPOINT_FILTER_ONLY_CURRENT]

ENDPOINT_FILTER_ALL  = 'all'

ENDPOINT_FILTER_NOT_CURRENT  = 'notCurrent'

ENDPOINT_FILTER_ONLY_CURRENT  = 'onlyCurrent'

Properties

$settings  : Settings

See Settings

Methods

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

Get all available and predefined endpoints within this environment. E. g. if your are running within a mulitisite, you will get all available WP REST API endpoints for each site within this multisite. That means, you need to add your endpoint as follows: `$endpoints["https://example.com/wp-json/real-cookie-banner/v1/consent/forward"] = 'My example'.`

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

Get the available endpoints which are part of this environment and active for the consent forwarding. Examples:

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

Get forward to external URLs.

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()  : array<string|int, string>

Get forward to URLs within the network.

getSettings()  : mixed

Getter.

isConsentForwarding()  : bool

Check if consent should be forwarded.

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.

setSettings()  : mixed

Setter.