- Documentation >
- API >
- Field Type >
- Field Types reference >
- Float Field Type
Float Field Type
This Field Type stores numeric values which are provided as floats.
Name |
Internal name |
Expected input |
Float |
ezfloat |
float |
PHP API Field Type
The Field Type expects a number as input. Both decimal and integer numbers are accepted.
Type |
Example |
float |
194079.572 |
int |
144 |
Value object
Properties
The Value class of this Field Type contains the following properties:
Property |
Type |
Description |
$value |
float |
This property will be used to store the value provided as a float. |
| // Value object content example
use eZ\Publish\Core\FieldType\Float\Type;
// Instantiates a Float Value object
$floatValue = new Type\Value();
$float->value = 284.773
|
Constructor
The Float\Value
constructor will initialize a new Value object with the value provided. It expects a numeric value with or without decimals.
| // Constructor example
use eZ\Publish\Core\FieldType\Float\Type;
// Instantiates a Float Value object
$floatValue = new Type\Value( 284.773 );
|
Validation
This Field Type supports FloatValueValidator
, defining maximum and minimum float value:
Name |
Type |
Default value |
Description |
minFloatValue |
float |
`null |
This setting defines the minimum value this Field Type will allow as input. |
maxFloatValue |
float |
`null |
This setting defines the maximum value this Field Type will allow as input. |
1
2
3
4
5
6
7
8
9
10
11
12
13
14 | // Validator configuration example in PHP
use eZ\Publish\Core\FieldType\Float\Type;
$contentTypeService = $repository->getContentTypeService();
$floatFieldCreateStruct = $contentTypeService->newFieldDefinitionCreateStruct( "float", "ezfloat" );
// Accept only numbers between 0.1 and 203.99
$floatFieldCreateStruct->validatorConfiguration = [
"FileSizeValidator" => [
"minFloatValue" => 0.1,
"maxFloatValue" => 203.99
]
];
|
Settings
This Field Type does not support settings.