DocumentUser
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, EnumResolverTrait
This is the document applied tax class.
The document applied taxes will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getBillingAddress() | Returns the document user billing address. | : DocumentUserBillingAddress|null |
| getCustomTags() | Returns the document user custom tags. | : array<string|int, DocumentUserCustomTag> |
| getEmail() | Returns the document user email. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getGender() | Returns the document user gender. | : string |
| getId() | Returns the element id. | : int |
| getLastUsed() | Returns the document user last used date. | : Date|null |
| getShippingAddress() | Returns the document user shipping address. | : DocumentUserShippingAddress|null |
| getUserId() | Returns the document user user internal identifier. | : int |
| 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
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
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 —getBillingAddress()
Returns the document user billing address.
public
getBillingAddress() : DocumentUserBillingAddress|null
Return values
DocumentUserBillingAddress|null —getCustomTags()
Returns the document user custom tags.
public
getCustomTags() : array<string|int, DocumentUserCustomTag>
Return values
array<string|int, DocumentUserCustomTag> —getEmail()
Returns the 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 document user gender.
public
getGender() : string
Return values
string —getId()
Returns the element id.
public
getId() : int
Return values
int —getLastUsed()
Returns the document user last used date.
public
getLastUsed() : Date|null
Return values
Date|null —getShippingAddress()
Returns the document user shipping address.
public
getShippingAddress() : DocumentUserShippingAddress|null
Return values
DocumentUserShippingAddress|null —getUserId()
Returns the document user user internal identifier.
public
getUserId() : int
Return values
int —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