DocumentShipping
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, ElementNameTrait, EnumResolverTrait
This is the document shipping class.
The document shipping 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 |
| $name | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getDiscounts() | Returns the document shipping discounts. | : array<string|int, DocumentShippingDiscount> |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getName() | Returns the element name on the website current language. | : string |
| getPrice() | Returns the document shipping price. | : float |
| getShipperPId() | Returns the document shipping shipper public identifier. | : string |
| getShippingCalculation() | Returns the document shipping calculation mode. | : string |
| getShippingSectionId() | Returns the document shipping section internal identifier. | : int |
| getShippingTypeId() | Returns the document shipping type internal identifier. | : int |
| getShippingTypeName() | Returns the document shipping type name. | : string |
| getShippingTypePId() | Returns the document shipping type public identifier. | : string |
| getTaxes() | Returns the document shipping taxes. | : array<string|int, DocumentShippingTax> |
| 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.
$name
protected
string
$name
= ''
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 —getDiscounts()
Returns the document shipping discounts.
public
getDiscounts() : array<string|int, DocumentShippingDiscount>
Return values
array<string|int, DocumentShippingDiscount> —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 —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPrice()
Returns the document shipping price.
public
getPrice() : float
Return values
float —getShipperPId()
Returns the document shipping shipper public identifier.
public
getShipperPId() : string
Return values
string —getShippingCalculation()
Returns the document shipping calculation mode.
public
getShippingCalculation() : string
Return values
string —getShippingSectionId()
Returns the document shipping section internal identifier.
public
getShippingSectionId() : int
Return values
int —getShippingTypeId()
Returns the document shipping type internal identifier.
public
getShippingTypeId() : int
Return values
int —getShippingTypeName()
Returns the document shipping type name.
public
getShippingTypeName() : string
Return values
string —getShippingTypePId()
Returns the document shipping type public identifier.
public
getShippingTypePId() : string
Return values
string —getTaxes()
Returns the document shipping taxes.
public
getTaxes() : array<string|int, DocumentShippingTax>
Return values
array<string|int, DocumentShippingTax> —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