RichDocumentShipment
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document shipment class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $getpId | : string | |
| $incomingDate | : string | |
| $items | : array<string|int, mixed> | |
| $originWarehouseGroupName | : string | |
| $physicalLocationName | : string | |
| $shipping | : RichDocumentShipping|null | |
| $status | : string | |
| $substatus | : 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 |
| getGetpId() | Returns the rich document shipment getpId. | : string |
| getIncomingDate() | Returns the rich document shipment incomingDate. | : string |
| getItems() | Returns the rich document shipment items. | : array<string|int, RichDocumentShipmentItem> |
| getOriginWarehouseGroupName() | Returns the rich document shipment originWarehouseGroupName. | : string |
| getPhysicalLocationName() | Returns the rich document shipment physicalLocationName. | : string |
| getShipping() | Returns the rich document shipment shipping. | : RichDocumentShipping|null |
| getStatus() | Returns the rich document shipment status. | : string |
| getSubstatus() | Returns the rich document shipment substatus. | : string |
| getTrackingNumber() | Returns the rich document shipment trackingNumber. | : string |
| getTrackingUrl() | Returns the rich document shipment trackingUrl. | : 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 | |
| setItems() | : void | |
| setShipping() | : void |
Properties
$error
protected
Error|null
$error
= null
$getpId
protected
string
$getpId
= ''
$incomingDate
protected
string
$incomingDate
= ''
$items
protected
array<string|int, mixed>
$items
= []
$originWarehouseGroupName
protected
string
$originWarehouseGroupName
= ''
$physicalLocationName
protected
string
$physicalLocationName
= ''
$shipping
protected
RichDocumentShipping|null
$shipping
= null
$status
protected
string
$status
= ''
$substatus
protected
string
$substatus
= ''
$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 —getGetpId()
Returns the rich document shipment getpId.
public
getGetpId() : string
Return values
string —getIncomingDate()
Returns the rich document shipment incomingDate.
public
getIncomingDate() : string
Return values
string —getItems()
Returns the rich document shipment items.
public
getItems() : array<string|int, RichDocumentShipmentItem>
Return values
array<string|int, RichDocumentShipmentItem> —getOriginWarehouseGroupName()
Returns the rich document shipment originWarehouseGroupName.
public
getOriginWarehouseGroupName() : string
Return values
string —getPhysicalLocationName()
Returns the rich document shipment physicalLocationName.
public
getPhysicalLocationName() : string
Return values
string —getShipping()
Returns the rich document shipment shipping.
public
getShipping() : RichDocumentShipping|null
Return values
RichDocumentShipping|null —getStatus()
Returns the rich document shipment status.
public
getStatus() : string
Return values
string —getSubstatus()
Returns the rich document shipment substatus.
public
getSubstatus() : string
Return values
string —getTrackingNumber()
Returns the rich document shipment trackingNumber.
public
getTrackingNumber() : string
Return values
string —getTrackingUrl()
Returns the rich document shipment trackingUrl.
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
Return values
void —setItems()
protected
setItems(array<string|int, mixed> $items) : void
Parameters
- $items : array<string|int, mixed>
Return values
void —setShipping()
protected
setShipping(array<string|int, mixed> $shipping) : void
Parameters
- $shipping : array<string|int, mixed>