ShippingType
in package
Uses ElementTrait, IdentifiableElementTrait, IntegrableElementTrait, ElementNameTrait

This is the shipping type class.

The shipping type information will be stored in that class and will remain immutable (only get methods are available)

Tags
see
ShippingType::getPriority()
see
ShippingType::getApplyTaxRedefinitions()
see
ShippingType::getSectionsWithTaxIncluded()
see
ShippingType::getRestrictive()
see
ShippingType::getDisplayPriority()
see
ShippingType::getShipper()
see
ShippingType::getLanguage()
see
ShippingType::getAdditionalData()
see
ElementTrait
see
IdentifiableElementTrait
see
IntegrableElementTrait

Table of Contents

$id Autonumeric element id.  : int
$name  : string
$pId Public and readable element id.  : string
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getAdditionalData() Returns the shipping type additional data.  : array<string|int, mixed>
getApplyTaxRedefinitions() Returns the shipping type apply tax redefinitions.  : bool
getDisplayPriority() Returns the shipping type display priority.  : int
getId() Returns the element id.  : int
getLanguage() Returns the shipping type language.  : ShippingTypeLanguage|null
getName() Returns the element name on the website current language.  : string
getPId() Returns the element public id (pId).  : string
getPriority() Returns the shipping type priority.  : int
getRestrictive() Returns the shipping type restrictive.  : bool
getSectionsWithTaxIncluded() Returns the shipping type sections with tax included.  : bool
getShipper() Returns the shipping type shipper.  : Shipper|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>

Properties

$id

Autonumeric element id.

protected int $id = 0

All the given elements by the LogiCommerce API will send it.

$pId

Public and readable element id.

protected string $pId = ''

Setted by the user on LogiCommerce. All the integrable elements by the LogiCommerce API will send it. Useful for integrations and other 3rd party softwares that need to connect to LogiCommerce software.

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 —

getAdditionalData()

Returns the shipping type additional data.

public getAdditionalData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getApplyTaxRedefinitions()

Returns the shipping type apply tax redefinitions.

public getApplyTaxRedefinitions() : bool
Return values
bool —

getDisplayPriority()

Returns the shipping type display priority.

public getDisplayPriority() : int
Return values
int —

getName()

Returns the element name on the website current language.

public getName() : string
Return values
string —

getPriority()

Returns the shipping type priority.

public getPriority() : int
Return values
int —

getRestrictive()

Returns the shipping type restrictive.

public getRestrictive() : bool
Return values
bool —

getSectionsWithTaxIncluded()

Returns the shipping type sections with tax included.

public getSectionsWithTaxIncluded() : bool
Return values
bool —

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> —

Search results