W3cubDocs

/Symfony 4.1

NumberToLocalizedStringTransformer

class NumberToLocalizedStringTransformer implements DataTransformerInterface

Transforms between a number type and a localized number with grouping (each thousand) and comma separators.

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
protected $roundingMode

Methods

__construct(int $scale = null, bool|null $grouping = false, int|null $roundingMode = self::ROUND_HALF_UP)
mixed transform(mixed $value)

Transforms a number type into localized number.

mixed reverseTransform(mixed $value)

Transforms a localized number into an integer or float.

NumberFormatter getNumberFormatter()

Returns a preconfigured \NumberFormatter instance.

Details

__construct(int $scale = null, bool|null $grouping = false, int|null $roundingMode = self::ROUND_HALF_UP)

Parameters

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

mixed transform(mixed $value)

Transforms a number type into localized number.

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

mixed reverseTransform(mixed $value)

Transforms a localized number into an integer or float.

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