UserAdditionalInformation
extends Element
in package
Uses
ElementTrait, UserAdditionalInformationTrait
This is the user additional information class.
The user exists information 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 |
| getChannel() | Returns the user channel. | : Channel|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getLastVisit() | Returns the user lastVisit. | : Date|null |
| getReferer() | Returns the user referer. | : string |
| getSimulatedUser() | Returns the simulated user data. | : bool |
| getUserAgent() | Returns the user userAgent. | : string |
| 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 —getChannel()
Returns the user channel.
public
getChannel() : Channel|null
Return values
Channel|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getLastVisit()
Returns the user lastVisit.
public
getLastVisit() : Date|null
Return values
Date|null —getReferer()
Returns the user referer.
public
getReferer() : string
Return values
string —getSimulatedUser()
Returns the simulated user data.
public
getSimulatedUser() : bool
Return values
bool —getUserAgent()
Returns the user userAgent.
public
getUserAgent() : string
Return values
string —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