Delivery
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the delivery class.
The basket delivery information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAllBasketWarnings() | Returns all the warnings inside the delivery rows array. | : array<string|int, BasketWarning> |
| getCanBeShipped() | Returns if the delivery is the canBeShipped one. | : bool |
| getDeliveryRows() | Returns the delivery deliveryRows. | : array<string|int, DeliveryRow> |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getHash() | Returns the delivery hash. | : string |
| getMultiShipment() | Returns if the delivery is the multiShipment one. | : bool |
| getPhysicalLocationId() | Returns the delivery physicalLocationId. | : int |
| getSelected() | Returns if the delivery is the selected one. | : bool |
| getShipments() | Returns the delivery shipments. | : array<string|int, Shipment>|array<string|int, BasketShipment> |
| getType() | Returns the delivery type. | : string |
| getZone() | Returns the delivery zone. | : GeographicalZone|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 | |
| 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
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 —getAllBasketWarnings()
Returns all the warnings inside the delivery rows array.
public
getAllBasketWarnings() : array<string|int, BasketWarning>
Return values
array<string|int, BasketWarning> —getCanBeShipped()
Returns if the delivery is the canBeShipped one.
public
getCanBeShipped() : bool
Return values
bool —getDeliveryRows()
Returns the delivery deliveryRows.
public
getDeliveryRows() : array<string|int, DeliveryRow>
Return values
array<string|int, DeliveryRow> —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getHash()
Returns the delivery hash.
public
getHash() : string
Return values
string —getMultiShipment()
Returns if the delivery is the multiShipment one.
public
getMultiShipment() : bool
Return values
bool —getPhysicalLocationId()
Returns the delivery physicalLocationId.
public
getPhysicalLocationId() : int
Return values
int —getSelected()
Returns if the delivery is the selected one.
public
getSelected() : bool
Return values
bool —getShipments()
Returns the delivery shipments.
public
getShipments() : array<string|int, Shipment>|array<string|int, BasketShipment>
Return values
array<string|int, Shipment>|array<string|int, BasketShipment> —getType()
Returns the delivery type.
public
getType() : string
Return values
string —getZone()
Returns the delivery zone.
public
getZone() : GeographicalZone|null
Return values
GeographicalZone|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 —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