General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

The documentation is moving!

We're moving our developer docs to Github and a new site.
The migration is still in progress, so please contact us in #documentation-contrib on eZ Community Slack if you have any questions or feedback.

This space will not be updated from now on except for critical fixes.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This Field Type represents a float value.

NameInternal nameExpected input
Floatezfloatfloat

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.

TypeExample
float

194079.572

int144

Value object

Properties

The Value class of this field type contains the following properties:

PropertyTypeDescription
$valuefloatThis property will be used to store the value provided as a float.
Code Block
languagephp
titleValue object content example
linenumberstrue
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
languagephp
titleConstructor example
linenumberstrue
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:

NameTypeDefault valueDescription
minFloatValuefloatnull
This setting defines the minimum value this FieldType will allow as input.
maxFloatValuefloatnull
This setting defines the maximum value this FieldType will allow as input.
Code Block
languagephp
titleValidator configuration example in PHP
linenumberstrue
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.