BaseShipment
extends Element
in package
Uses
EnumResolverTrait
This is the base shipment class.
The base shipments information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $destinationZone | : GeographicalZone|null | |
|---|---|---|
| $error | : Error|null | |
| $hash | : string | |
| $originWarehouseGroupId | : int | |
| $rows | : array<string|int, mixed> | |
| $shippingCalculation | : string | |
| getDestinationZone() | Returns the shipment destination zone. | : GeographicalZone|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getHash() | Returns the shipment hash. | : string |
| getOriginWarehouseGroupId() | Returns the shipment origin warehouse group internal id. | : int |
| getRows() | Returns the shipment rows. | : array<string|int, ShipmentRow> |
| getShippingCalculation() | Returns the shipment shipping calculation. | : string |
| setDestinationZone() | : void | |
| setError() | : void | |
| setRows() | : void |
Properties
$destinationZone
protected
GeographicalZone|null
$destinationZone
= null
$error
protected
Error|null
$error
= null
$hash
protected
string
$hash
= ''
$originWarehouseGroupId
protected
int
$originWarehouseGroupId
= 0
$rows
protected
array<string|int, mixed>
$rows
= []
$shippingCalculation
protected
string
$shippingCalculation
= ''
Methods
getDestinationZone()
Returns the shipment destination zone.
public
getDestinationZone() : GeographicalZone|null
Return values
GeographicalZone|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getHash()
Returns the shipment hash.
public
getHash() : string
Return values
string —getOriginWarehouseGroupId()
Returns the shipment origin warehouse group internal id.
public
getOriginWarehouseGroupId() : int
Return values
int —getRows()
Returns the shipment rows.
public
getRows() : array<string|int, ShipmentRow>
Return values
array<string|int, ShipmentRow> —getShippingCalculation()
Returns the shipment shipping calculation.
public
getShippingCalculation() : string
Return values
string —setDestinationZone()
protected
setDestinationZone(array<string|int, mixed> $destinationZone) : void
Parameters
- $destinationZone : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setRows()
protected
setRows(array<string|int, mixed> $rows) : void
Parameters
- $rows : array<string|int, mixed>