Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This Field Type represents a float value.
| Name | Internal name | Expected input |
|---|---|---|
Float | ezfloat | float |
Description
This Field Type stores numeric values which will be provided as floats.
PHP API Field Type
Input expectations
The Field Type expects a number as input. Both decimal and integer numbers are accepted.
| Type | Example |
|---|---|
float |
|
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. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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 maximal and minimal float value:
| Name | Type | Default value | Description |
|---|---|---|---|
minFloatValue | float | false | This setting defines the minimum value this FieldType will allow as input. |
maxFloatValue | float | false | This setting defines the maximum value this FieldType will allow as input. |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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 = array(
"FileSizeValidator" => array(
"minFloatValue" => 0.1,
"maxFloatValue" => 203.99
)
); |
Settings
This Field Type does not support settings.