FloatConverter

Converter which transforms a float, integer or string to a float.

This is basically done by simply casting it, unless the input is a string and you provide some configuration options which will make this converter use Flow's locale parsing capabilities in order to respect deviating decimal separators.

Using NULL or an empty string as input will result in a NULL return value.

Advanced usage in action controller context

Using default locale::

protected function initializeCreateAction() { $this->arguments['newBid']->getPropertyMappingConfiguration()->forProperty('price')->setTypeConverterOption( \Neos\Flow\Property\TypeConverter\FloatConverter::class, 'locale', true ); }

Just providing true as option value will use the current default locale. In case that default locale is "DE" for Germany for example, where a comma is used as decimal separator, the mentioned code will return (float)15.5 when the input was (string)"15,50".

Using arbitrary locale::

protected function initializeCreateAction() { $this->arguments['newBid']->getPropertyMappingConfiguration()->forProperty('price')->setTypeConverterOption( \Neos\Flow\Property\TypeConverter\FloatConverter::class, 'locale', 'fr' ); }

Parsing mode

There are two parsing modes available, strict and lenient mode. Strict mode will check all constraints of the provided format, and if any of them are not fulfilled, the conversion will not take place. In Lenient mode the parser will try to extract the intended number from the string, even if it's not well formed. Default for strict mode is true.

Example setting lenient mode (abridged)::

->setTypeConverterOption( \Neos\Flow\Property\TypeConverter\FloatConverter::class, 'strictMode', false );

Format type

Format type can be decimal, percent or currency; represented as class constant FORMAT_TYPE_DECIMAL, FORMAT_TYPE_PERCENT or FORMAT_TYPE_CURRENCY of class Neos\Flow\I18n\Cldr\Reader\NumbersReader. Default, if none given, is FORMAT_TYPE_DECIMAL.

Example setting format type currency (abridged)::

->setTypeConverterOption( \Neos\Flow\Property\TypeConverter\FloatConverter::class, 'formatType', \Neos\Flow\I18n\Cldr\Reader\NumbersReader::FORMAT_TYPE_CURRENCY );

Format length

Format type can be default, full, long, medium or short; represented as class constant FORMAT_LENGTH_DEFAULT, FORMAT_LENGTH_FULL, FORMAT_LENGTH_LONG etc., of class Neos\Flow\I18n\Cldr\Reader\NumbersReader. The format length has a technical background in the CLDR repository, and specifies whether a different number pattern should be used. In most cases leaving this DEFAULT would be the correct choice.

Example setting format length (abridged)::

->setTypeConverterOption( \Neos\Flow\Property\TypeConverter\FloatConverter::class, 'formatLength', \Neos\Flow\I18n\Cldr\Reader\NumbersReader::FORMAT_LENGTH_FULL );