Consent
Class Consent
Table of Contents
Constants
- EVENT_NAME_LIST = 'OnUserConsentProviderList'
Methods
- addByContext() : int|null
- Add user consent by context data.
- getByContext() : array<string|int, mixed>|null
- Get user consent added by context data.
- getItems() : string|null
- Get items data.
- getOriginData() : array<string|int, mixed>|null
- Get origin data.
Constants
EVENT_NAME_LIST
public
mixed
EVENT_NAME_LIST
= 'OnUserConsentProviderList'
Methods
addByContext()
Add user consent by context data.
public
static addByContext(int $agreementId[, int|null $originatorId = null ][, int|null $originId = null ][, array<string|int, mixed> $params = array() ]) : int|null
Parameters
- $agreementId : int
-
Agreement ID.
- $originatorId : int|null = null
-
Originator ID.
- $originId : int|null = null
-
Origin ID.
- $params : array<string|int, mixed> = array()
-
Extra params like IP, URL or USER_ID.
Return values
int|nullgetByContext()
Get user consent added by context data.
public
static getByContext(int $agreementId[, int|null $originatorId = null ][, int|null $originId = null ][, array<string|int, mixed> $params = array() ]) : array<string|int, mixed>|null
Parameters
- $agreementId : int
-
Agreement ID.
- $originatorId : int|null = null
-
Originator ID.
- $originId : int|null = null
-
Origin ID.
- $params : array<string|int, mixed> = array()
-
Extra params.
Return values
array<string|int, mixed>|nullgetItems()
Get items data.
public
static getItems(string $originatorId[, array<string|int, mixed> $items = [] ]) : string|null
Parameters
- $originatorId : string
-
Originator ID.
- $items : array<string|int, mixed> = []
-
Source Items.
Return values
string|nullgetOriginData()
Get origin data.
public
static getOriginData(string $originatorId[, string|int|null $originId = null ]) : array<string|int, mixed>|null
Parameters
- $originatorId : string
-
Originator ID.
- $originId : string|int|null = null
-
Origin ID.