class MoneyToLocalizedStringTransformer extends NumberToLocalizedStringTransformer

Transforms between a normalized format and a localized money string.

Constants

ROUND_CEILING

Rounds a number towards positive infinity.

Rounds 1.4 to 2 and -1.4 to -1.

ROUND_FLOOR

Rounds a number towards negative infinity.

Rounds 1.4 to 1 and -1.4 to -2.

ROUND_UP

Rounds a number away from zero.

Rounds 1.4 to 2 and -1.4 to -2.

ROUND_DOWN

Rounds a number towards zero.

Rounds 1.4 to 1 and -1.4 to -1.

ROUND_HALF_EVEN

Rounds to the nearest number and halves to the next even number.

Rounds 2.5, 1.6 and 1.5 to 2 and 1.4 to 1.

ROUND_HALF_UP

Rounds to the nearest number and halves away from zero.

Rounds 2.5 to 3, 1.6 and 1.5 to 2 and 1.4 to 1.

ROUND_HALF_DOWN

Rounds to the nearest number and halves towards zero.

Rounds 2.5 and 1.6 to 2, 1.5 and 1.4 to 1.

Properties

protected $grouping from NumberToLocalizedStringTransformer
protected $roundingMode from NumberToLocalizedStringTransformer

Methods

__construct(int $scale = 2, bool|null $grouping = true, int|null $roundingMode = self::ROUND_HALF_UP, int|null $divisor = 1)

No description

mixed
transform(mixed $value)

Transforms a normalized format into a localized money string.

mixed
reverseTransform(mixed $value)

Transforms a localized money string into a normalized format.

getNumberFormatter()

Returns a preconfigured \NumberFormatter instance.

Details

at line 26
__construct(int $scale = 2, bool|null $grouping = true, int|null $roundingMode = self::ROUND_HALF_UP, int|null $divisor = 1)

Parameters

int $scale
bool|null $grouping
int|null $roundingMode
int|null $divisor

at line 55
mixed transform(mixed $value)

Transforms a normalized format into a localized money string.

Parameters

mixed $value The value in the original representation

Return Value

mixed The value in the transformed representation

Exceptions

TransformationFailedException if the given value is not numeric or if the value can not be transformed

at line 77
mixed reverseTransform(mixed $value)

Transforms a localized money string into a normalized format.

Parameters

mixed $value The value in the transformed representation

Return Value

mixed The value in the original representation

Exceptions

TransformationFailedException if the given value is not a string or if the value can not be transformed

protected NumberFormatter getNumberFormatter()

Returns a preconfigured \NumberFormatter instance.

Return Value

NumberFormatter

protected castParsedValue($value)

Parameters

$value