UserReturn
extends UserDocument
in package
Uses
ElementTrait, EnumResolverTrait
This is the user return main class.
The user return information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $date | : Date|null | |
|---|---|---|
| $documentNumber | : string | |
| $documentType | : string | |
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $pId | Public and readable element id. | : string |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getCorrectiveInvoices() | Returns the user return corrective invoices. | : array<string|int, UserCorrectiveInvoice> |
| getDate() | Returns the order date. | : Date|null |
| getDocumentNumber() | Returns the order document number. | : string |
| getDocumentType() | Returns the user return document type. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getPId() | Returns the element public id (pId). | : 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> |
| setDate() | : void | |
| setError() | : void |
Properties
$date
protected
Date|null
$date
= null
$documentNumber
protected
string
$documentNumber
= ''
$documentType
protected
string
$documentType
= ''
$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.
$pId
Public and readable element id.
protected
string
$pId
= ''
Setted by the user on LogiCommerce. All the integrable elements by the LogiCommerce API will send it. Useful for integrations and other 3rd party softwares that need to connect to LogiCommerce software.
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 —getCorrectiveInvoices()
Returns the user return corrective invoices.
public
getCorrectiveInvoices() : array<string|int, UserCorrectiveInvoice>
Return values
array<string|int, UserCorrectiveInvoice> —getDate()
Returns the order date.
public
getDate() : Date|null
Return values
Date|null —getDocumentNumber()
Returns the order document number.
public
getDocumentNumber() : string
Return values
string —getDocumentType()
Returns the user return document type.
public
getDocumentType() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getId()
Returns the element id.
public
getId() : int
Return values
int —getPId()
Returns the element public id (pId).
public
getPId() : 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> —setDate()
protected
setDate(string $date) : void
Parameters
- $date : string
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed