Documentation

VendorConfiguration
in package

A TCF vendor configuration.

Table of Contents

Properties

$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?
$id  : int
The ID of the content blocker when it got created in a stafeul way.
$restrictivePurposes  : array<string|int, mixed>
Restrictive purposes settings.
$usedDeclarations  : array<string|int, mixed>
An array of used declarations (purposes, special purposes, ...) so the best suitable stacks can be calculated from that result.
$vendor  : array<string|int, mixed>
The vendor object from the GVL.
$vendorId  : int
The vendor ID from the official GVL vendor list.

Methods

applyRestrictivePurposes()  : mixed
"Correct" the restrictive purposes (e.g. `global` scope does not allow configurations) of a TCF vendor configuration. It fills `$used` with used declarations.
fromJson()  : self
Generate a `VendorConfiguration` object from an array.
getDataProcessingInCountries()  : mixed
Getter.
getDataProcessingInCountriesSpecialTreatments()  : mixed
Getter.
getId()  : mixed
Getter.
getRestrictivePurposes()  : mixed
Getter.
getUsedDeclarations()  : mixed
Getter.
getVendor()  : mixed
Getter.
getVendorId()  : mixed
Getter.
setDataProcessingInCountries()  : mixed
Setter.
setDataProcessingInCountriesSpecialTreatments()  : mixed
Setter.
setId()  : mixed
Setter.
setRestrictivePurposes()  : mixed
Setter.
setVendor()  : mixed
Setter.
setVendorId()  : mixed
Setter.
toJson()  : mixed
Create a JSON representation of this object.

Properties

$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 = []

$id

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

private int $id = 0

$restrictivePurposes

Restrictive purposes settings.

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

$usedDeclarations

An array of used declarations (purposes, special purposes, ...) so the best suitable stacks can be calculated from that result.

private array<string|int, mixed> $usedDeclarations = [\DevOwl\CookieConsentManagement\tcf\StackCalculator::DECLARATION_TYPE_PURPOSES => [], \DevOwl\CookieConsentManagement\tcf\StackCalculator::DECLARATION_TYPE_SPECIAL_PURPOSES => [], \DevOwl\CookieConsentManagement\tcf\StackCalculator::DECLARATION_TYPE_FEATURES => [], \DevOwl\CookieConsentManagement\tcf\StackCalculator::DECLARATION_TYPE_SPECIAL_FEATURES => [], \DevOwl\CookieConsentManagement\tcf\StackCalculator::DECLARATION_TYPE_DATA_CATEGORIES => []]

$vendorId

The vendor ID from the official GVL vendor list.

private int $vendorId = 0

Methods

applyRestrictivePurposes()

"Correct" the restrictive purposes (e.g. `global` scope does not allow configurations) of a TCF vendor configuration. It fills `$used` with used declarations.

public applyRestrictivePurposes(string $scope) : mixed
Parameters
$scope : string

Can be global or service-specific

fromJson()

Generate a `VendorConfiguration` object from an array.

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

The used vendor object for this vendor configuration

Return values
self

getDataProcessingInCountries()

Getter.

public getDataProcessingInCountries() : mixed
Tags
codeCoverageIgnore

getDataProcessingInCountriesSpecialTreatments()

Getter.

public getDataProcessingInCountriesSpecialTreatments() : mixed
Tags
codeCoverageIgnore

getRestrictivePurposes()

Getter.

public getRestrictivePurposes() : mixed
Tags
codeCoverageIgnore

getUsedDeclarations()

Getter.

public getUsedDeclarations() : mixed
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, mixed> $dataProcessingInCountriesSpecialTreatments) : mixed
Parameters
$dataProcessingInCountriesSpecialTreatments : array<string|int, mixed>
Tags
codeCoverageIgnore

setId()

Setter.

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

setRestrictivePurposes()

Setter.

public setRestrictivePurposes(RestrictivePurposes $restrictivePurposes) : mixed
Parameters
$restrictivePurposes : RestrictivePurposes
Tags
codeCoverageIgnore

setVendor()

Setter.

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

setVendorId()

Setter.

public setVendorId(int $vendorId) : mixed
Parameters
$vendorId : int
Tags
codeCoverageIgnore 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results