RichDocumentShipping
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document shipping class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $discounts | : array<string|int, mixed> | |
|---|---|---|
| $error | : Error|null | |
| $name | : string | |
| $price | : string | |
| $priceWithDiscounts | : string | |
| $priceWithDiscountsWithTaxes | : string | |
| $priceWithTaxes | : string | |
| $shipperId | : string | |
| $shippingCalculation | : string | |
| $shippingSectionId | : int | |
| $shippingTypeName | : string | |
| $shippingTypePId | : string | |
| $taxes | : array<string|int, mixed> | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getDiscounts() | Returns the rich document shipping taxes. | : array<string|int, RichDocumentDiscount> |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getName() | Returns the rich document shipping name. | : string |
| getPrice() | Returns the rich document shipping price. | : string |
| getPriceWithDiscounts() | Returns the rich document shipping priceWithDiscounts. | : string |
| getPriceWithDiscountsWithTaxes() | Returns the rich document shipping priceWithDiscountsWithTaxes. | : string |
| getPriceWithTaxes() | Returns the rich document shipping priceWithTaxes. | : string |
| getShipperId() | Returns the rich document shipping shipperId. | : string |
| getShippingCalculation() | Returns the rich document shipment shippingCalculation. | : string |
| getShippingSectionId() | Returns the rich document shipping shippingSectionId. | : int |
| getShippingTypeName() | Returns the rich document shipping shippingTypeName. | : string |
| getShippingTypePId() | Returns the rich document shipping shippingTypePId. | : string |
| getTaxes() | Returns the rich document shipping taxes. | : array<string|int, RichDocumentElementTax> |
| 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> |
| setDiscounts() | : void | |
| setError() | : void | |
| setTaxes() | : void |
Properties
$discounts
protected
array<string|int, mixed>
$discounts
= []
$error
protected
Error|null
$error
= null
$name
protected
string
$name
= ''
$price
protected
string
$price
= ''
$priceWithDiscounts
protected
string
$priceWithDiscounts
= ''
$priceWithDiscountsWithTaxes
protected
string
$priceWithDiscountsWithTaxes
= ''
$priceWithTaxes
protected
string
$priceWithTaxes
= ''
$shipperId
protected
string
$shipperId
= ''
$shippingCalculation
protected
string
$shippingCalculation
= ''
$shippingSectionId
protected
int
$shippingSectionId
= 0
$shippingTypeName
protected
string
$shippingTypeName
= ''
$shippingTypePId
protected
string
$shippingTypePId
= ''
$taxes
protected
array<string|int, mixed>
$taxes
= []
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 rich document shipping taxes.
public
getDiscounts() : array<string|int, RichDocumentDiscount>
Return values
array<string|int, RichDocumentDiscount> —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getName()
Returns the rich document shipping name.
public
getName() : string
Return values
string —getPrice()
Returns the rich document shipping price.
public
getPrice() : string
Return values
string —getPriceWithDiscounts()
Returns the rich document shipping priceWithDiscounts.
public
getPriceWithDiscounts() : string
Return values
string —getPriceWithDiscountsWithTaxes()
Returns the rich document shipping priceWithDiscountsWithTaxes.
public
getPriceWithDiscountsWithTaxes() : string
Return values
string —getPriceWithTaxes()
Returns the rich document shipping priceWithTaxes.
public
getPriceWithTaxes() : string
Return values
string —getShipperId()
Returns the rich document shipping shipperId.
public
getShipperId() : string
Return values
string —getShippingCalculation()
Returns the rich document shipment shippingCalculation.
public
getShippingCalculation() : string
Return values
string —getShippingSectionId()
Returns the rich document shipping shippingSectionId.
public
getShippingSectionId() : int
Return values
int —getShippingTypeName()
Returns the rich document shipping shippingTypeName.
public
getShippingTypeName() : string
Return values
string —getShippingTypePId()
Returns the rich document shipping shippingTypePId.
public
getShippingTypePId() : string
Return values
string —getTaxes()
Returns the rich document shipping taxes.
public
getTaxes() : array<string|int, RichDocumentElementTax>
Return values
array<string|int, RichDocumentElementTax> —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> —setDiscounts()
protected
setDiscounts(array<string|int, mixed> $discounts) : void
Parameters
- $discounts : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setTaxes()
protected
setTaxes(array<string|int, mixed> $taxes) : void
Parameters
- $taxes : array<string|int, mixed>