Shipping
in package
Uses
ElementTrait
This is the shipping class.
The shipping information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| __construct() | Elements constructor. | : mixed |
|---|---|---|
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAppliedDiscounts() | Returns the shipping applied discounts. | : array<string|int, AppliedDiscount> |
| getAppliedTaxes() | Returns the shipping applied taxes. | : array<string|int, AppliedTax> |
| getHash() | Returns the shipping hash. | : string |
| getPrices() | Returns the shipping prices. | : ShippingPrices|null |
| getPricesWithTaxes() | Returns the shipping prices with taxes. | : ShippingPrices|null |
| getType() | Returns the shipping type. | : ShippingType|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> |
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 —getAppliedDiscounts()
Returns the shipping applied discounts.
public
getAppliedDiscounts() : array<string|int, AppliedDiscount>
Return values
array<string|int, AppliedDiscount> —getAppliedTaxes()
Returns the shipping applied taxes.
public
getAppliedTaxes() : array<string|int, AppliedTax>
Return values
array<string|int, AppliedTax> —getHash()
Returns the shipping hash.
public
getHash() : string
Return values
string —getPrices()
Returns the shipping prices.
public
getPrices() : ShippingPrices|null
Return values
ShippingPrices|null —getPricesWithTaxes()
Returns the shipping prices with taxes.
public
getPricesWithTaxes() : ShippingPrices|null
Return values
ShippingPrices|null —getType()
Returns the shipping type.
public
getType() : ShippingType|null
Return values
ShippingType|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