AppliedDiscountGiftTotal
extends AppliedDiscount
in package
Uses
ElementTrait
This is the general basket applied discount gift class.
Tags
Table of Contents
| $description | : string | |
|---|---|---|
| $discountId | : int | |
| $discountValue | : float | |
| $error | : Error|null | |
| $items | : array<string|int, mixed> | |
| $name | : string | |
| $type | : string | |
| $value | : float | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getDescription() | Returns the element description on the website current language. | : string |
| getDiscountId() | Returns the applied discount internal identifier. | : int |
| getDiscountValue() | Returns the applied discount value for the amount type. | : float |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getItems() | Returns the applied discount items. | : array<string|int, BasketRow> |
| getName() | Returns the element name on the website current language. | : string |
| getType() | Returns the applied discount type. | : string |
| getValue() | Returns the applied discount 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> |
| setError() | : void | |
| setItems() | : void |
Properties
$description
protected
string
$description
= ''
$discountId
protected
int
$discountId
= 0
$discountValue
protected
float
$discountValue
= 0.0
$error
protected
Error|null
$error
= null
$items
protected
array<string|int, mixed>
$items
= []
$name
protected
string
$name
= ''
$type
protected
string
$type
= ''
$value
protected
float
$value
= 0.0
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 —getDescription()
Returns the element description on the website current language.
public
getDescription() : string
Return values
string —getDiscountId()
Returns the applied discount internal identifier.
public
getDiscountId() : int
Return values
int —getDiscountValue()
Returns the applied discount value for the amount type.
public
getDiscountValue() : float
Return values
float —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getItems()
Returns the applied discount items.
public
getItems() : array<string|int, BasketRow>
Return values
array<string|int, BasketRow> —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getType()
Returns the applied discount type.
public
getType() : string
Return values
string —getValue()
Returns the applied discount value.
public
getValue() : 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> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setItems()
protected
setItems(array<string|int, mixed> $items) : void
Parameters
- $items : array<string|int, mixed>