UserDocumentShipment
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait
This is the user returns request main class.
The user returns request information 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 |
| $pickupDate | : string | |
| $pId | Public and readable element id. | : string |
| $trackingNumber | : string | |
| $trackingURL | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getPackages() | Returns the user shipment package. | : array<string|int, UserDocumentShippingTrackingPackage> |
| getPickupDate() | Returns the shipment pickup date. | : string |
| getPId() | Returns the element public id (pId). | : string |
| getTrackingNumber() | Returns the shipment tracking number. | : string |
| getTrackingURL() | Returns the shipment tracking url. | : 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
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$pickupDate
protected
string
$pickupDate
= ''
$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.
$trackingNumber
protected
string
$trackingNumber
= ''
$trackingURL
protected
string
$trackingURL
= ''
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 —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 —getPackages()
Returns the user shipment package.
public
getPackages() : array<string|int, UserDocumentShippingTrackingPackage>
Return values
array<string|int, UserDocumentShippingTrackingPackage> —getPickupDate()
Returns the shipment pickup date.
public
getPickupDate() : string
Return values
string —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getTrackingNumber()
Returns the shipment tracking number.
public
getTrackingNumber() : string
Return values
string —getTrackingURL()
Returns the shipment tracking url.
public
getTrackingURL() : 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