Class Number

Responsibility: init, pre-dispatch and render <input> HTML element with types number and type range in extended class. Number field and it's extended fields have their own validator(s) to parse and check submitted value by min/max/step/pattern. This field always return parsed float or NULL.

MvcCore\Ext\Forms\Field implements MvcCore\Ext\Forms\IField uses MvcCore\Ext\Forms\Field\Props, MvcCore\Ext\Forms\Field\Getters, MvcCore\Ext\Forms\Field\Setters, MvcCore\Ext\Forms\Field\Rendering

Direct known subclasses

MvcCore\Ext\Forms\Fields\Range

Namespace: MvcCore\Ext\Forms\Fields
Located at ext-form-field-numeric/src/MvcCore/Ext/Forms/Fields/Number.php

Methods summary
`public float\|null`	# `GetValue( )` Get numeric field value as `float`. Get numeric field value as `float`. Returns float\|null Overrides `MvcCore\Ext\Forms\Field\Getters::GetValue()`
`public MvcCore\Ext\Forms\Validators\Number`	# `SetValue( float\|null $value )` Set numeric field value as `float`. Set numeric field value as `float`. Parameters `$value` Returns `MvcCore\Ext\Forms\Validators\Number` Overrides `MvcCore\Ext\Forms\Field\Setters::SetValue()`
`public MvcCore\Ext\Forms\Fields\Number`	# `SetForm( MvcCore\Ext\IForm $form )` This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form instance by `$form->AddField();` method. Do not use this method even if you don't develop any form field. - Check if field has any name, which is required. - Set up form and field id attribute by form id and field name. - Set up required. - Set up translate boolean property. - Set up pattern validator automatically if any `pattern` property defined. This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form instance by `$form->AddField();` method. Do not use this method even if you don't develop any form field. - Check if field has any name, which is required. - Set up form and field id attribute by form id and field name. - Set up required. - Set up translate boolean property. - Set up pattern validator automatically if any `pattern` property defined. Parameters `$form` Returns `MvcCore\Ext\Forms\Fields\Number` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::SetForm()`
`public array &`	# `GetValidatorData( array $fieldPropsDefaultValidValues = [] )` Return field specific data for validator. Return field specific data for validator. Parameters `$fieldPropsDefaultValidValues` Returns array Overrides `MvcCore\Ext\Forms\Field::GetValidatorData()`
`public`	# `PreDispatch( )` This INTERNAL method is called from `\MvcCore\Ext\Form` just before field is naturally rendered. It sets up field for rendering process. Do not use this method even if you don't develop any form field. - Set up field render mode if not defined. - Translate label text if necessary. - Set up `inputmode` field attribute if necessary. - Set up tab-index if necessary. This INTERNAL method is called from `\MvcCore\Ext\Form` just before field is naturally rendered. It sets up field for rendering process. Do not use this method even if you don't develop any form field. - Set up field render mode if not defined. - Translate label text if necessary. - Set up `inputmode` field attribute if necessary. - Set up tab-index if necessary. Overrides `MvcCore\Ext\Forms\Field::PreDispatch()`
`public string`	# `RenderControl( )` This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering` in rendering process. Do not use this method even if you don't develop any form field. Render control tag only without label or specific errors. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderControl()`

Methods inherited from MvcCore\Ext\Forms\Field
`AddValidationError(), CreateInstance(), Submit(), __call(), __construct(), __get(), __set(), throwNewInvalidArgumentException(), translateAndFormatValidationError()`

Methods inherited from MvcCore\Ext\Forms\IField
AddControlAttrs(), AddCssClasses(), AddError(), AddValidators(), GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetType(), GetValidators(), GetViewScript(), HasValidator(), RemoveValidator(), Render(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), RenderTemplate(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetViewScript()

Methods inherited from MvcCore\Ext\Forms\Fields\IVisibleField
`GetAccessKey(), GetAutoFocus(), GetDisabled(), GetReadOnly(), GetRequired(), GetTabIndex(), SetAccessKey(), SetAutoFocus(), SetDisabled(), SetReadOnly(), SetRequired(), SetTabIndex()`

Methods inherited from MvcCore\Ext\Forms\Fields\ILabel
`AddLabelAttrs(), GetLabel(), GetLabelAttr(), GetLabelAttrs(), GetLabelSide(), GetRenderMode(), SetLabel(), SetLabelAttr(), SetLabelAttrs(), SetLabelSide(), SetRenderMode()`

Methods inherited from MvcCore\Ext\Forms\Fields\IMinMaxStepNumbers
`GetMax(), GetMin(), GetStep(), SetMax(), SetMin(), SetStep()`

Methods inherited from MvcCore\Ext\Forms\Fields\IDataList
`GetList(), SetList()`

Methods used from MvcCore\Ext\Forms\Field\Props\Label
`AddLabelAttrs(), GetLabel(), GetLabelAttr(), GetLabelAttrs(), GetLabelSide(), GetRenderMode(), SetLabel(), SetLabelAttr(), SetLabelAttrs(), SetLabelSide(), SetRenderMode()`

Methods used from MvcCore\Ext\Forms\Field\Props\MinMaxStepNumbers
`GetMax(), GetMin(), GetStep(), SetMax(), SetMin(), SetStep()`

Methods used from MvcCore\Ext\Forms\Field\Props\DataList
`GetList(), SetList()`

Methods used from MvcCore\Ext\Forms\Field\Props\AutoComplete
`GetAutoComplete(), SetAutoComplete()`

Methods used from MvcCore\Ext\Forms\Field\Props\PlaceHolder
`GetPlaceHolder(), SetPlaceHolder(), preDispatchPlaceHolder()`

Methods used from MvcCore\Ext\Forms\Field\Props\Wrapper
`GetWrapper(), SetWrapper(), renderControlWrapper()`

Methods used from MvcCore\Ext\Forms\Field\Props\InputMode
`GetInputMode(), SetInputMode(), preDispatchInputMode()`

Methods used from MvcCore\Ext\Forms\Field\Getters
`GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetTranslate(), GetType(), GetValidators(), GetViewScript(), HasValidator()`

Methods used from MvcCore\Ext\Forms\Field\Setters
`AddControlAttrs(), AddCssClasses(), AddError(), AddValidators(), RemoveValidator(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetViewScript()`

Methods used from MvcCore\Ext\Forms\Field\Rendering
`Render(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), RenderTemplate(), renderAttrsWithFieldVars(), renderControlAttrsWithFieldVars(), renderLabelAttrsWithFieldVars()`

Constants summary
`string`	`VERSION` MvcCore Extension - Form - Field - Numeric - version: Comparison by PHP function version_compare(); MvcCore Extension - Form - Field - Numeric - version: Comparison by PHP function version_compare(); See http://php.net/manual/en/function.version-compare.php	# `'5.0.0'`

Constants inherited from MvcCore\Ext\Forms\IField
`AUTOFOCUS_DUPLICITY_EXCEPTION, AUTOFOCUS_DUPLICITY_QUIETLY_SET_NEW, AUTOFOCUS_DUPLICITY_UNSET_OLD_SET_NEW, LABEL_SIDE_LEFT, LABEL_SIDE_RIGHT`

Properties summary
`protected string`	`$type` Possible values: `number` and `range` in extended class. Possible values: `number` and `range` in extended class.	# `'number'`
`protected string[]\|Closure[]`	`$validators` Validators: - `Number` - to parse and check raw user input. Parse float value if possible by `Intl` extension or try to determinate floating point automatically and return `float` or `NULL`. Validators: - `Number` - to parse and check raw user input. Parse float value if possible by `Intl` extension or try to determinate floating point automatically and return `float` or `NULL`.	# `['Number']`
`protected float\|null`	`$value` Numeric field value is always stored as float value. Numeric field value is always stored as float value.	# `NULL`

Properties used from MvcCore\Ext\Forms\Field\Props
`$controlAttrs, $cssClasses, $cssSupportingFile, $declaredProtectedProperties, $errors, $form, $id, $jsClassName, $jsSupportingFile, $name, $templates, $title, $translate, $translateTitle, $view, $viewScript`

Properties used from MvcCore\Ext\Forms\Field\Props\Label
`$label, $labelAttrs, $labelSide, $renderMode, $translateLabel`

Properties used from MvcCore\Ext\Forms\Field\Props\MinMaxStepNumbers
`$max, $min, $step`

Properties used from MvcCore\Ext\Forms\Field\Props\DataList
`$list`

Properties used from MvcCore\Ext\Forms\Field\Props\AutoComplete
`$autoComplete`

Properties used from MvcCore\Ext\Forms\Field\Props\PlaceHolder
`$placeHolder, $translatePlaceholder`

Properties used from MvcCore\Ext\Forms\Field\Props\Wrapper
`$wrapper`

Properties used from MvcCore\Ext\Forms\Field\Props\InputMode
`$fieldTypesAndInputModes, $inputMode`

Classes

Interfaces

Traits

Exceptions

Functions

Class Number

Direct known subclasses

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides

Overrides

Returns

Overrides

See