RichDocumentUser
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document user class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $additionalInfo | : RichDocumentUserAdditional|null | |
|---|---|---|
| $billingAddress | : RichDocumentUserBillingAddress|null | |
| $customTags | : array<string|int, mixed> | |
| : string | ||
| $error | : Error|null | |
| $gender | : string | |
| $lastUsed | : RichDateTime|null | |
| $shippingAddress | : RichDocumentUserShippingAddress|null | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAdditionalInfo() | Returns the rich document user additionalInfo. | : RichDocumentUserAdditional|null |
| getBillingAddress() | Returns the rich document user billingAddress. | : RichDocumentUserBillingAddress|null |
| getCustomTags() | Returns the rich document user customTags. | : array<string|int, RichDocumentCustomTag> |
| getEmail() | Returns the rich document user email. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getGender() | Returns the rich document user gender. | : string |
| getLastUsed() | Returns the rich document user lastUsed. | : RichDateTime|null |
| getShippingAddress() | Returns the rich document user shippingAddress. | : RichDocumentUserShippingAddress|null |
| 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 | |
| setAdditionalInfo() | : void | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setBillingAddress() | : void | |
| setCustomTags() | : void | |
| setError() | : void | |
| setLastUsed() | : void | |
| setShippingAddress() | : void |
Properties
$additionalInfo
protected
RichDocumentUserAdditional|null
$additionalInfo
= null
$billingAddress
protected
RichDocumentUserBillingAddress|null
$billingAddress
= null
$customTags
protected
array<string|int, mixed>
$customTags
= []
protected
string
$email
= ''
$error
protected
Error|null
$error
= null
$gender
protected
string
$gender
= ''
$lastUsed
protected
RichDateTime|null
$lastUsed
= null
$shippingAddress
protected
RichDocumentUserShippingAddress|null
$shippingAddress
= 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 —getAdditionalInfo()
Returns the rich document user additionalInfo.
public
getAdditionalInfo() : RichDocumentUserAdditional|null
Return values
RichDocumentUserAdditional|null —getBillingAddress()
Returns the rich document user billingAddress.
public
getBillingAddress() : RichDocumentUserBillingAddress|null
Return values
RichDocumentUserBillingAddress|null —getCustomTags()
Returns the rich document user customTags.
public
getCustomTags() : array<string|int, RichDocumentCustomTag>
Return values
array<string|int, RichDocumentCustomTag> —getEmail()
Returns the rich document user email.
public
getEmail() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getGender()
Returns the rich document user gender.
public
getGender() : string
Return values
string —getLastUsed()
Returns the rich document user lastUsed.
public
getLastUsed() : RichDateTime|null
Return values
RichDateTime|null —getShippingAddress()
Returns the rich document user shippingAddress.
public
getShippingAddress() : RichDocumentUserShippingAddress|null
Return values
RichDocumentUserShippingAddress|null —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 —setAdditionalInfo()
protected
setAdditionalInfo(array<string|int, mixed> $additionalInfo) : void
Parameters
- $additionalInfo : array<string|int, mixed>
Return values
void —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> —setBillingAddress()
protected
setBillingAddress(array<string|int, mixed> $billingAddress) : void
Parameters
- $billingAddress : array<string|int, mixed>
Return values
void —setCustomTags()
protected
setCustomTags(array<string|int, mixed> $customTags) : void
Parameters
- $customTags : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setLastUsed()
protected
setLastUsed(array<string|int, mixed> $lastUsed) : void
Parameters
- $lastUsed : array<string|int, mixed>
Return values
void —setShippingAddress()
protected
setShippingAddress(array<string|int, mixed> $shippingAddress) : void
Parameters
- $shippingAddress : array<string|int, mixed>