BasketTax
in package
Uses ElementTrait, TaxTrait

This is the basket tax class.

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

Tags
see
BasketTax::getDiscount()
see
BasketTax::getTaxRate()
see
BasketTax::getReRate()
see
BasketTax::getTaxValue()
see
ElementTrait
see
TaxTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getBase() Returns the tax base.  : float
getDiscount() Returns the basket tax discount.  : float
getReRate() Returns the basket tax re rate.  : float
getTaxRate() Returns the basket tax rate.  : float
getTaxValue() Returns the basket tax value.  : float
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 —

getBase()

Returns the tax base.

public getBase() : float
Return values
float —

getDiscount()

Returns the basket tax discount.

public getDiscount() : float
Return values
float —

getReRate()

Returns the basket tax re rate.

public getReRate() : float
Return values
float —

getTaxRate()

Returns the basket tax rate.

public getTaxRate() : float
Return values
float —

getTaxValue()

Returns the basket tax value.

public getTaxValue() : float
Return values
float —

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