Documentation

Service
in package

A service.

Table of Contents

Constants

LEGAL_BASIS  = [self::LEGAL_BASIS_CONSENT, self::LEGAL_BASIS_LEGAL_REQUIREMENT, self::LEGAL_BASIS_LEGITIMATE_INTEREST]
LEGAL_BASIS_CONSENT  = 'consent'
LEGAL_BASIS_LEGAL_REQUIREMENT  = 'legal-requirement'
LEGAL_BASIS_LEGITIMATE_INTEREST  = 'legitimate-interest'
SPECIAL_TREATMENT_PROVIDER_IS_SELF_CERTIFIED_TRANS_ATLANTIC_DATA_PRIVACY_FRAMEWORK  = 'provider-is-self-certified-trans-atlantic-data-privacy-framework'
SPECIAL_TREATMENT_STANDARD_CONTRACTUAL_CLAUSES  = 'standard-contractual-clauses'

Properties

$codeDynamics  : array<string|int, mixed>
List of code dynamics applied to the embed scripts.
$codeOnPageLoad  : string
The HTML code on page load.
$codeOptIn  : string
The HTML code on opt-in.
$codeOptOut  : string
The HTML code on opt-out.
$dataProcessingInCountries  : array<string|int, string>
Iso 3166-1 alpha 2 countries in which the service is processing data.
$dataProcessingInCountriesSpecialTreatments  : array<string|int, string>
Are there special treatments when processing data in unsafe countries?
$deleteTechnicalDefinitionsAfterOptOut  : bool
Delete the technical definitions after opt-out.
$executeCodeOptInWhenNoTagManagerConsentIsGiven  : bool
Execute the code on opt-in only when no tag manager consent is given.
$executeCodeOptOutWhenNoTagManagerConsentIsGiven  : bool
Execute the code on opt-out only when no tag manager consent is given.
$googleConsentModeConsentTypes  : array<string|int, string>
If Google Consent Mode is active the required consent types.
$id  : int
The ID of the service when it got created in a stafeul way.
$isEmbeddingOnlyExternalResources  : bool
Is the service embedding only external resources and no cookies?
$isProviderCurrentWebsite  : bool
Is the current website the provider of the service?
$legalBasis  : string
The legal basis of the service.
$name  : string
Service name.
$presetId  : string
The used preset ID from the service cloud.
$provider  : string
Provider.
$providerContact  : ProviderContact
Provider contact.
$providerLegalNoticeUrl  : string
Provider legal notice URL.
$providerPrivacyPolicyUrl  : string
Provider privacy policy URL.
$purpose  : string
Service purpose.
$tagManagerOptInEventName  : string
If tag manager handling is active the opt-in event name.
$tagManagerOptOutEventName  : string
If tag manager handling is active the opt-out event name.
$technicalDefinitions  : array<string|int, TechnicalDefinitions>
The technical definitions for the cookies used by the service.
$uniqueName  : string
Unique name.

Methods

applyDynamicsToHtml()  : mixed
Takes a HTML string and apply code dynamics to it.
calculateUnsafeCountries()  : array<string|int, string>
Calculate unsafe countries from a given array of countries.
fromJson()  : self
Generate a `Service` object from an array.
getCodeDynamics()  : mixed
Getter.
getCodeOnPageLoad()  : mixed
Getter.
getCodeOptIn()  : mixed
Getter.
getCodeOptOut()  : mixed
Getter.
getDataProcessingInCountries()  : mixed
Getter.
getDataProcessingInCountriesSpecialTreatments()  : mixed
Getter.
getDeleteTechnicalDefinitionsAfterOptOut()  : mixed
Getter.
getExecuteCodeOptInWhenNoTagManagerConsentIsGiven()  : mixed
Getter.
getExecuteCodeOptOutWhenNoTagManagerConsentIsGiven()  : mixed
Getter.
getGoogleConsentModeConsentTypes()  : mixed
Getter.
getId()  : mixed
Getter.
getLegalBasis()  : mixed
Getter.
getName()  : mixed
Getter.
getPresetId()  : mixed
Getter.
getProvider()  : mixed
Getter.
getProviderContact()  : mixed
Getter.
getProviderLegalNoticeUrl()  : mixed
Getter.
getProviderPrivacyPolicyUrl()  : mixed
Getter.
getPurpose()  : mixed
Getter.
getTagManagerOptInEventName()  : mixed
Getter.
getTagManagerOptOutEventName()  : mixed
Getter.
getTechnicalDefinitions()  : mixed
Getter.
getUniqueName()  : mixed
Getter.
isEmbeddingOnlyExternalResources()  : mixed
Getter.
isProviderCurrentWebsite()  : mixed
Getter.
setCodeDynamics()  : mixed
Setter.
setCodeOnPageLoad()  : mixed
Setter.
setCodeOptIn()  : mixed
Setter.
setCodeOptOut()  : mixed
Setter.
setDataProcessingInCountries()  : mixed
Setter.
setDataProcessingInCountriesSpecialTreatments()  : mixed
Setter.
setDeleteTechnicalDefinitionsAfterOptOut()  : mixed
Setter.
setExecuteCodeOptInWhenNoTagManagerConsentIsGiven()  : mixed
Setter.
setExecuteCodeOptOutWhenNoTagManagerConsentIsGiven()  : mixed
Setter.
setGoogleConsentModeConsentTypes()  : mixed
Setter.
setId()  : mixed
Setter.
setIsEmbeddingOnlyExternalResources()  : mixed
Setter.
setIsProviderCurrentWebsite()  : mixed
Setter.
setLegalBasis()  : mixed
Setter.
setName()  : mixed
Setter.
setPresetId()  : mixed
Setter.
setProvider()  : mixed
Setter.
setProviderContact()  : mixed
Setter.
setProviderLegalNoticeUrl()  : mixed
Setter.
setProviderPrivacyPolicyUrl()  : mixed
Setter.
setPurpose()  : mixed
Setter.
setTagManagerOptInEventName()  : mixed
Setter.
setTagManagerOptOutEventName()  : mixed
Setter.
setTechnicalDefinitions()  : mixed
Setter.
setUniqueName()  : mixed
Setter.
toJson()  : mixed
Create a JSON representation of this object.

Constants

LEGAL_BASIS

public mixed LEGAL_BASIS = [self::LEGAL_BASIS_CONSENT, self::LEGAL_BASIS_LEGAL_REQUIREMENT, self::LEGAL_BASIS_LEGITIMATE_INTEREST]

LEGAL_BASIS_CONSENT

public mixed LEGAL_BASIS_CONSENT = 'consent'

LEGAL_BASIS_LEGAL_REQUIREMENT

public mixed LEGAL_BASIS_LEGAL_REQUIREMENT = 'legal-requirement'

LEGAL_BASIS_LEGITIMATE_INTEREST

public mixed LEGAL_BASIS_LEGITIMATE_INTEREST = 'legitimate-interest'

SPECIAL_TREATMENT_PROVIDER_IS_SELF_CERTIFIED_TRANS_ATLANTIC_DATA_PRIVACY_FRAMEWORK

public mixed SPECIAL_TREATMENT_PROVIDER_IS_SELF_CERTIFIED_TRANS_ATLANTIC_DATA_PRIVACY_FRAMEWORK = 'provider-is-self-certified-trans-atlantic-data-privacy-framework'

SPECIAL_TREATMENT_STANDARD_CONTRACTUAL_CLAUSES

public mixed SPECIAL_TREATMENT_STANDARD_CONTRACTUAL_CLAUSES = 'standard-contractual-clauses'

Properties

$codeDynamics

List of code dynamics applied to the embed scripts.

private array<string|int, mixed> $codeDynamics = []

$codeOnPageLoad

The HTML code on page load.

private string $codeOnPageLoad = ''

$codeOptIn

The HTML code on opt-in.

private string $codeOptIn = ''

$codeOptOut

The HTML code on opt-out.

private string $codeOptOut

$dataProcessingInCountries

Iso 3166-1 alpha 2 countries in which the service is processing data.

private array<string|int, string> $dataProcessingInCountries = []

$dataProcessingInCountriesSpecialTreatments

Are there special treatments when processing data in unsafe countries?

private array<string|int, string> $dataProcessingInCountriesSpecialTreatments = []

$deleteTechnicalDefinitionsAfterOptOut

Delete the technical definitions after opt-out.

private bool $deleteTechnicalDefinitionsAfterOptOut = false

$executeCodeOptInWhenNoTagManagerConsentIsGiven

Execute the code on opt-in only when no tag manager consent is given.

private bool $executeCodeOptInWhenNoTagManagerConsentIsGiven = false

$executeCodeOptOutWhenNoTagManagerConsentIsGiven

Execute the code on opt-out only when no tag manager consent is given.

private bool $executeCodeOptOutWhenNoTagManagerConsentIsGiven = false

$googleConsentModeConsentTypes

If Google Consent Mode is active the required consent types.

private array<string|int, string> $googleConsentModeConsentTypes = []

$id

The ID of the service when it got created in a stafeul way.

private int $id = 0

$isEmbeddingOnlyExternalResources

Is the service embedding only external resources and no cookies?

private bool $isEmbeddingOnlyExternalResources = false

$isProviderCurrentWebsite

Is the current website the provider of the service?

private bool $isProviderCurrentWebsite = false

$legalBasis

The legal basis of the service.

private string $legalBasis = self::LEGAL_BASIS_CONSENT

$name

Service name.

private string $name = ''

$presetId

The used preset ID from the service cloud.

private string $presetId = ''

$provider

Provider.

private string $provider = ''

$providerLegalNoticeUrl

Provider legal notice URL.

private string $providerLegalNoticeUrl = ''

$providerPrivacyPolicyUrl

Provider privacy policy URL.

private string $providerPrivacyPolicyUrl = ''

$purpose

Service purpose.

private string $purpose = ''

$tagManagerOptInEventName

If tag manager handling is active the opt-in event name.

private string $tagManagerOptInEventName = ''

$tagManagerOptOutEventName

If tag manager handling is active the opt-out event name.

private string $tagManagerOptOutEventName = ''

$technicalDefinitions

The technical definitions for the cookies used by the service.

private array<string|int, TechnicalDefinitions> $technicalDefinitions = []

$uniqueName

Unique name.

private string $uniqueName = ''

Methods

applyDynamicsToHtml()

Takes a HTML string and apply code dynamics to it.

public applyDynamicsToHtml(string $html) : mixed
Parameters
$html : string

calculateUnsafeCountries()

Calculate unsafe countries from a given array of countries.

public static calculateUnsafeCountries(array<string|int, string> $countries[, mixed $specialTreatments = [] ]) : array<string|int, string>

See also frontend-packages/react-cookie-banner/src/components/common/groups/cookiePropertyList.tsx the calculateUnsafeCountries method.

Parameters
$countries : array<string|int, string>
$specialTreatments : mixed = []
Return values
array<string|int, string>

fromJson()

Generate a `Service` object from an array.

public static fromJson(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

getCodeDynamics()

Getter.

public getCodeDynamics() : mixed
Tags
codeCoverageIgnore

getCodeOnPageLoad()

Getter.

public getCodeOnPageLoad() : mixed
Tags
codeCoverageIgnore

getCodeOptIn()

Getter.

public getCodeOptIn() : mixed
Tags
codeCoverageIgnore

getCodeOptOut()

Getter.

public getCodeOptOut() : mixed
Tags
codeCoverageIgnore

getDataProcessingInCountries()

Getter.

public getDataProcessingInCountries() : mixed
Tags
codeCoverageIgnore

getDataProcessingInCountriesSpecialTreatments()

Getter.

public getDataProcessingInCountriesSpecialTreatments() : mixed
Tags
codeCoverageIgnore

getDeleteTechnicalDefinitionsAfterOptOut()

Getter.

public getDeleteTechnicalDefinitionsAfterOptOut() : mixed
Tags
codeCoverageIgnore

getExecuteCodeOptInWhenNoTagManagerConsentIsGiven()

Getter.

public getExecuteCodeOptInWhenNoTagManagerConsentIsGiven() : mixed
Tags
codeCoverageIgnore

getExecuteCodeOptOutWhenNoTagManagerConsentIsGiven()

Getter.

public getExecuteCodeOptOutWhenNoTagManagerConsentIsGiven() : mixed
Tags
codeCoverageIgnore

getGoogleConsentModeConsentTypes()

Getter.

public getGoogleConsentModeConsentTypes() : mixed
Tags
codeCoverageIgnore

getId()

Getter.

public getId() : mixed
Tags
codeCoverageIgnore

getLegalBasis()

Getter.

public getLegalBasis() : mixed
Tags
codeCoverageIgnore

getName()

Getter.

public getName() : mixed
Tags
codeCoverageIgnore

getPresetId()

Getter.

public getPresetId() : mixed
Tags
codeCoverageIgnore

getProvider()

Getter.

public getProvider() : mixed
Tags
codeCoverageIgnore

getProviderContact()

Getter.

public getProviderContact() : mixed
Tags
codeCoverageIgnore

getProviderLegalNoticeUrl()

Getter.

public getProviderLegalNoticeUrl() : mixed
Tags
codeCoverageIgnore

getProviderPrivacyPolicyUrl()

Getter.

public getProviderPrivacyPolicyUrl() : mixed
Tags
codeCoverageIgnore

getPurpose()

Getter.

public getPurpose() : mixed
Tags
codeCoverageIgnore

getTagManagerOptInEventName()

Getter.

public getTagManagerOptInEventName() : mixed
Tags
codeCoverageIgnore

getTagManagerOptOutEventName()

Getter.

public getTagManagerOptOutEventName() : mixed
Tags
codeCoverageIgnore

getTechnicalDefinitions()

Getter.

public getTechnicalDefinitions() : mixed
Tags
codeCoverageIgnore

getUniqueName()

Getter.

public getUniqueName() : mixed
Tags
codeCoverageIgnore

isEmbeddingOnlyExternalResources()

Getter.

public isEmbeddingOnlyExternalResources() : mixed
Tags
codeCoverageIgnore

isProviderCurrentWebsite()

Getter.

public isProviderCurrentWebsite() : mixed
Tags
codeCoverageIgnore

setCodeDynamics()

Setter.

public setCodeDynamics(array<string|int, mixed> $codeDynamics) : mixed
Parameters
$codeDynamics : array<string|int, mixed>
Tags
codeCoverageIgnore

setCodeOnPageLoad()

Setter.

public setCodeOnPageLoad(string $codeOnPageLoad) : mixed
Parameters
$codeOnPageLoad : string
Tags
codeCoverageIgnore

setCodeOptIn()

Setter.

public setCodeOptIn(string $codeOptIn) : mixed
Parameters
$codeOptIn : string
Tags
codeCoverageIgnore

setCodeOptOut()

Setter.

public setCodeOptOut(string $codeOptOut) : mixed
Parameters
$codeOptOut : string
Tags
codeCoverageIgnore

setDataProcessingInCountries()

Setter.

public setDataProcessingInCountries(array<string|int, string> $dataProcessingInCountries) : mixed
Parameters
$dataProcessingInCountries : array<string|int, string>
Tags
codeCoverageIgnore

setDataProcessingInCountriesSpecialTreatments()

Setter.

public setDataProcessingInCountriesSpecialTreatments(array<string|int, string> $dataProcessingInCountriesSpecialTreatments) : mixed
Parameters
$dataProcessingInCountriesSpecialTreatments : array<string|int, string>
Tags
codeCoverageIgnore

setDeleteTechnicalDefinitionsAfterOptOut()

Setter.

public setDeleteTechnicalDefinitionsAfterOptOut(bool $deleteTechnicalDefinitionsAfterOptOut) : mixed
Parameters
$deleteTechnicalDefinitionsAfterOptOut : bool
Tags
codeCoverageIgnore

setExecuteCodeOptInWhenNoTagManagerConsentIsGiven()

Setter.

public setExecuteCodeOptInWhenNoTagManagerConsentIsGiven(bool $executeCodeOptInWhenNoTagManagerConsentIsGiven) : mixed
Parameters
$executeCodeOptInWhenNoTagManagerConsentIsGiven : bool
Tags
codeCoverageIgnore

setExecuteCodeOptOutWhenNoTagManagerConsentIsGiven()

Setter.

public setExecuteCodeOptOutWhenNoTagManagerConsentIsGiven(bool $executeCodeOptOutWhenNoTagManagerConsentIsGiven) : mixed
Parameters
$executeCodeOptOutWhenNoTagManagerConsentIsGiven : bool
Tags
codeCoverageIgnore

setGoogleConsentModeConsentTypes()

Setter.

public setGoogleConsentModeConsentTypes(array<string|int, string> $googleConsentModeConsentTypes) : mixed
Parameters
$googleConsentModeConsentTypes : array<string|int, string>
Tags
codeCoverageIgnore

setId()

Setter.

public setId(int $id) : mixed
Parameters
$id : int
Tags
codeCoverageIgnore

setIsEmbeddingOnlyExternalResources()

Setter.

public setIsEmbeddingOnlyExternalResources(bool $isEmbeddingOnlyExternalResources) : mixed
Parameters
$isEmbeddingOnlyExternalResources : bool
Tags
codeCoverageIgnore

setIsProviderCurrentWebsite()

Setter.

public setIsProviderCurrentWebsite(bool $isProviderCurrentWebsite) : mixed
Parameters
$isProviderCurrentWebsite : bool
Tags
codeCoverageIgnore

setLegalBasis()

Setter.

public setLegalBasis(string $legalBasis) : mixed
Parameters
$legalBasis : string
Tags
codeCoverageIgnore

setName()

Setter.

public setName(string $name) : mixed
Parameters
$name : string
Tags
codeCoverageIgnore

setPresetId()

Setter.

public setPresetId(string $presetId) : mixed
Parameters
$presetId : string
Tags
codeCoverageIgnore

setProvider()

Setter.

public setProvider(string $provider) : mixed
Parameters
$provider : string
Tags
codeCoverageIgnore

setProviderLegalNoticeUrl()

Setter.

public setProviderLegalNoticeUrl(string $providerLegalNoticeUrl) : mixed
Parameters
$providerLegalNoticeUrl : string
Tags
codeCoverageIgnore

setProviderPrivacyPolicyUrl()

Setter.

public setProviderPrivacyPolicyUrl(string $providerPrivacyPolicyUrl) : mixed
Parameters
$providerPrivacyPolicyUrl : string
Tags
codeCoverageIgnore

setPurpose()

Setter.

public setPurpose(string $purpose) : mixed
Parameters
$purpose : string
Tags
codeCoverageIgnore

setTagManagerOptInEventName()

Setter.

public setTagManagerOptInEventName(string $tagManagerOptInEventName) : mixed
Parameters
$tagManagerOptInEventName : string
Tags
codeCoverageIgnore

setTagManagerOptOutEventName()

Setter.

public setTagManagerOptOutEventName(string $tagManagerOptOutEventName) : mixed
Parameters
$tagManagerOptOutEventName : string
Tags
codeCoverageIgnore

setTechnicalDefinitions()

Setter.

public setTechnicalDefinitions(array<string|int, TechnicalDefinitions> $technicalDefinitions) : mixed
Parameters
$technicalDefinitions : array<string|int, TechnicalDefinitions>
Tags
codeCoverageIgnore

setUniqueName()

Setter.

public setUniqueName(string $uniqueName) : mixed
Parameters
$uniqueName : string
Tags
codeCoverageIgnore

toJson()

Create a JSON representation of this object.

public toJson() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results