Formatter
FinalYes
Table of Contents
Constants
- LIMIT_MAX = 'MAX'
- LIMIT_MIN = 'MIN'
- TYPE_FIXED = 0x8
- TYPE_LIMIT_VALUE = 0x4
- TYPE_MAX_BOUND = 0x10
- TYPE_SIMPLE = 0x1
- TYPE_SIMPLE_GIFT = 0x20
- TYPE_VALUE = 0x2
- VALUE_ACTION_CUMULATIVE = 'A'
- VALUE_ACTION_DISCOUNT = 'D'
- VALUE_ACTION_EXTRA = 'E'
- VALUE_TYPE_CURRENCY = 'C'
- VALUE_TYPE_PERCENT = 'P'
- VALUE_TYPE_SUMM = 'S'
- VALUE_TYPE_SUMM_BASKET = 'B'
Methods
- clearErrors() : void
- Clear formatter errors.
- formatList() : array<string|int, mixed>|null
- Format discount result.
- formatRow() : null|string
- Returns format action or result description.
- getErrors() : array<string|int, mixed>
- Returns formatter errors.
- prepareRow() : null|array<string|int, mixed>
- Prepare action or result description.
Constants
LIMIT_MAX
public
mixed
LIMIT_MAX
= 'MAX'
LIMIT_MIN
public
mixed
LIMIT_MIN
= 'MIN'
TYPE_FIXED
public
mixed
TYPE_FIXED
= 0x8
TYPE_LIMIT_VALUE
public
mixed
TYPE_LIMIT_VALUE
= 0x4
TYPE_MAX_BOUND
public
mixed
TYPE_MAX_BOUND
= 0x10
TYPE_SIMPLE
public
mixed
TYPE_SIMPLE
= 0x1
TYPE_SIMPLE_GIFT
public
mixed
TYPE_SIMPLE_GIFT
= 0x20
TYPE_VALUE
public
mixed
TYPE_VALUE
= 0x2
VALUE_ACTION_CUMULATIVE
public
mixed
VALUE_ACTION_CUMULATIVE
= 'A'
VALUE_ACTION_DISCOUNT
public
mixed
VALUE_ACTION_DISCOUNT
= 'D'
VALUE_ACTION_EXTRA
public
mixed
VALUE_ACTION_EXTRA
= 'E'
VALUE_TYPE_CURRENCY
public
mixed
VALUE_TYPE_CURRENCY
= 'C'
VALUE_TYPE_PERCENT
public
mixed
VALUE_TYPE_PERCENT
= 'P'
VALUE_TYPE_SUMM
public
mixed
VALUE_TYPE_SUMM
= 'S'
VALUE_TYPE_SUMM_BASKET
public
mixed
VALUE_TYPE_SUMM_BASKET
= 'B'
Methods
clearErrors()
Clear formatter errors.
public
static clearErrors() : void
formatList()
Format discount result.
public
static formatList(array<string|int, mixed> $actionList) : array<string|int, mixed>|null
Parameters
- $actionList : array<string|int, mixed>
-
Descriptions.
Return values
array<string|int, mixed>|nullformatRow()
Returns format action or result description.
public
static formatRow(array<string|int, mixed> $action) : null|string
Parameters
- $action : array<string|int, mixed>
-
Action description.
Return values
null|stringgetErrors()
Returns formatter errors.
public
static getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>prepareRow()
Prepare action or result description.
public
static prepareRow(int $type, array<string|int, mixed>|string $data) : null|array<string|int, mixed>
Parameters
- $type : int
-
Action description type.
- $data : array<string|int, mixed>|string
-
Action description data.