Documentation

Transaction

in package

• Application

A transaction simply describes a new consent.

Table of Contents

Properties

$blocker  : int

If the consent came from a content blocker, the ID of the content blocker.

$blockerThumbnail  : int|string

Can be the ID of the blocker thumbnail itself, or in format of `{embedId}-{fileMd5}`.

$buttonClicked  : string

The clicked button in the cookie banner.

$createdClientTime  : string

The ISO string of `new Date().toISOString()` on client side which reflects the time of consent given (not persist time).

$customBypass  : string

Allows to set a custom bypass which causes the banner to be hidden (e.g. Geolocation)

$decision  : array<string|int, mixed>|string

A set of accepted cookie groups + cookies or a predefined set like `all` or `essentials`.

$forwarded  : int

The reference to the consent ID of the source website (only for forwarded consents).

$forwardedBlocker  : bool

Determine if forwarded consent came through a content blocker.

$forwardedUuid  : string

The UUID reference of the source website.

$gcmConsent  : array<string|int, string>

Google Consent Mode consent types.

$ipAddress  : string

The IP address of the website visitor.

$markAsDoNotTrack  : bool

Mark as DNT.

$recorderJsonString  : string

Recorder JSON string for Replays.

$referer  : string

Referer.

$setCookies  : mixed

When `false`, the newly added transaction will not return any `SetCookie` instances. Use this, if you just want to save / persist a consent to the database but should not be updated on client side (e.g. delayed consents when server was not reachable).

$tcfString  : string

TCF string.

$uiView  : string

Can be `initial` (the cookie banner pops up for first time with first and second layer or content blocker) or `change` (Change privacy settings). `null` indicates a UI was never visible.

$userAgent  : string

The user agent of the website visitor.

$userCountry  : string

The country of the website visitor. This is automatically calculated when you pass in an IP address and you have enabled Geo Restriction (Country Bypass).

$viewPortHeight  : int

The viewport height.

$viewPortWidth  : int

The viewport width.

Methods

__construct()  : mixed

C'tor.

getBlocker()  : int

Get the blocker.

getBlockerThumbnail()  : int|string

Get the blocker thumbnail.

getButtonClicked()  : string

Get the button clicked.

getCreatedClientTime()  : string

Get the created client time.

getCustomBypass()  : string

Get the custom bypass.

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

Get the decision.

getForwarded()  : int

Get the forwarded consent ID.

getForwardedUuid()  : string

Get the forwarded UUID.

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

Get the Google Consent Mode consent types.

getIpAddress()  : string

Get the IP address.

getRecorderJsonString()  : string

Get the recorder JSON string.

getReferer()  : string

Get the referer.

getTcfString()  : string

Get the TCF string.

getUiView()  : string

Get the UI view.

getUserAgent()  : string

Get the user agent.

getUserCountry()  : string

Get the user country.

getViewPortHeight()  : int

Get the viewport height.

getViewPortWidth()  : int

Get the viewport width.

isForwardedBlocker()  : bool

Get whether the forwarded consent came through a content blocker.

isMarkAsDoNotTrack()  : bool

Get whether the consent is marked as Do Not Track.

isSetCookies()  : bool

Get whether the consent should be set on cookies.

setBlocker()  : mixed

Set the blocker.

setBlockerThumbnail()  : mixed

Set the blocker thumbnail.

setButtonClicked()  : mixed

Set the button clicked.

setCreatedClientTime()  : mixed

Set the created client time.

setCustomBypass()  : mixed

Set the custom bypass.

setDecision()  : mixed

Set the decision.

setForwarded()  : mixed

Set the forwarded consent.

setGcmConsent()  : mixed

Set the Google Consent Mode consent types.

setIpAddress()  : mixed

Set the IP address.

setMarkAsDoNotTrack()  : mixed

Set if the consent should be marked as Do Not Track.

setRecorderJsonString()  : mixed

Set the recorder JSON string.

setReferer()  : mixed

Set the referer.

setSetCookies()  : mixed

Set if the consent should be set on cookies.

setTcfString()  : mixed

Set the TCF string.

setUiView()  : mixed

Set the UI view.

setUserAgent()  : mixed

Set the user agent.

setUserCountry()  : mixed

Set the user country.

setViewPort()  : mixed

Set the viewport width and height.