LegalSettings
extends Element
in package
Uses
ElementTrait
This is the legal settings class.
The legal settings will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getActiveGDPR() | Returns the legal settings active GDPR. | : bool |
| getAllowCookiesBlock() | Returns the legal settings allow cookies block. | : bool |
| getAutoAcceptCookies() | Returns the legal settings auto accept cookies. | : bool |
| getCheckSubscription() | Returns the legal settings check subscription. | : bool |
| getCookieActive() | Returns the legal settings cookie active. | : bool |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getLegalText() | Returns the legal settings legal text. | : string |
| getPrivacyPolicy() | Returns the legal settings privacy policy. | : string |
| getRecordsMaintainedMonths() | Returns the legal settings records naintained months. | : int|null |
| getUseCookiesByDefault() | Returns the legal settings use cookies by default. | : bool |
| jsonSerialize() | Allow elements to be serialized. | : array<string|int, mixed> |
| toArray() | Used to allow elements to be serialized. | : array<string|int, mixed> |
| getFieldItem() | : object|null | |
| getFormattedData() | : mixed | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setError() | : void |
Properties
$error
protected
Error|null
$error
= null
Methods
__construct()
Elements constructor.
public
__construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
-
Array that contains all the values to the object to initialize
Return values
mixed —__toString()
Uses "json_encode" function to return the JSON format of the element.
public
__toString() : string
Auto-invoked using echo or concatenations.
Return values
string —getActiveGDPR()
Returns the legal settings active GDPR.
public
getActiveGDPR() : bool
Return values
bool —getAllowCookiesBlock()
Returns the legal settings allow cookies block.
public
getAllowCookiesBlock() : bool
Return values
bool —getAutoAcceptCookies()
Returns the legal settings auto accept cookies.
public
getAutoAcceptCookies() : bool
Return values
bool —getCheckSubscription()
Returns the legal settings check subscription.
public
getCheckSubscription() : bool
Return values
bool —getCookieActive()
Returns the legal settings cookie active.
public
getCookieActive() : bool
Return values
bool —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getLegalText()
Returns the legal settings legal text.
public
getLegalText() : string
Return values
string —getPrivacyPolicy()
Returns the legal settings privacy policy.
public
getPrivacyPolicy() : string
Return values
string —getRecordsMaintainedMonths()
Returns the legal settings records naintained months.
public
getRecordsMaintainedMonths() : int|null
Return values
int|null —getUseCookiesByDefault()
Returns the legal settings use cookies by default.
public
getUseCookiesByDefault() : bool
Return values
bool —jsonSerialize()
Allow elements to be serialized.
public
jsonSerialize() : array<string|int, mixed>
Auto-invoked using "json_encode" function.
Return values
array<string|int, mixed> —toArray()
Used to allow elements to be serialized.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFieldItem()
protected
getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
- $item : array<string|int, mixed>
- $class : string
Return values
object|null —getFormattedData()
protected
getFormattedData(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —setArrayField()
Convert an API array of objects to a PHP array of objects.
protected
setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
Array that contains all the values to the objects to initialize
- $class : string
-
The PHP class we want the objects to be
Return values
array<string|int, mixed> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed