VoucherGroup
in package
Uses ElementTrait

This is the basket voucher group class.

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

Tags
see
VoucherGroup::getDiscountCodes()
see
VoucherGroup::getVouchers()
see
VoucherGroup::getDirectVouchers()
see
ElementTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getDirectVouchers() Returns an array with the basket direct vouchers.  : array<string|int, Voucher>
getDiscountCodes() Returns an array with the basket discount codes.  : array<string|int, DiscountCode>
getVouchers() Returns an array with the basket vouchers.  : array<string|int, Voucher>
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 —

getDirectVouchers()

Returns an array with the basket direct vouchers.

public getDirectVouchers() : array<string|int, Voucher>
Return values
array<string|int, Voucher> —

getDiscountCodes()

Returns an array with the basket discount codes.

public getDiscountCodes() : array<string|int, DiscountCode>
Return values
array<string|int, DiscountCode> —

getVouchers()

Returns an array with the basket vouchers.

public getVouchers() : array<string|int, Voucher>
Return values
array<string|int, Voucher> —

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