Class Field

Responsibility: init, pre-dispatch and render common form control, it could be input, select or textarea. This class is not possible to instantiate, you need to extend this class to create own specific form control.

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

Indirect known subclasses

Abstract
Namespace: MvcCore\Ext\Forms
Located at ext-form/src/MvcCore/Ext/Forms/Field.php

Methods summary
`public static MvcCore\Ext\Forms\Field`	# `CreateInstance( array $cfg = [] )` Create new form control instance. Create new form control instance. Parameters `$cfg` Config array with public properties and it's values which you want to configure, presented in camel case properties names syntax. Returns `MvcCore\Ext\Forms\Field` Throws InvalidArgumentException Implementation of `MvcCore\Ext\Forms\IField::CreateInstance()`
`public`	# `__construct( array $cfg = [] )` Create new form control instance. Create new form control instance. Parameters `$cfg` Config array with public properties and it's values which you want to configure, presented in camel case properties names syntax. Throws InvalidArgumentException
`public mixed\|MvcCore\Ext\Forms\Field`	# `__call( string $name, array $arguments = [] )` Sets any custom property `"propertyName"` by `\MvcCore\Ext\Forms\Field::SetPropertyName("value");`, which is not necessary to define previously or gets previously defined property `"propertyName"` by `\MvcCore\Ext\Forms\Field::GetPropertyName();`. Throws exception if no property defined by get call or if virtual call begins with anything different from `Set` or `Get`. This method returns custom value for get and `\MvcCore\Request` instance for set. Sets any custom property `"propertyName"` by `\MvcCore\Ext\Forms\Field::SetPropertyName("value");`, which is not necessary to define previously or gets previously defined property `"propertyName"` by `\MvcCore\Ext\Forms\Field::GetPropertyName();`. Throws exception if no property defined by get call or if virtual call begins with anything different from `Set` or `Get`. This method returns custom value for get and `\MvcCore\Request` instance for set. Parameters `$name` `$arguments` Returns mixed\|`MvcCore\Ext\Forms\Field` Throws InvalidArgumentException
`public mixed`	# `__get( string $name )` Universal getter, if property not defined - `NULL` is returned. Universal getter, if property not defined - `NULL` is returned. Parameters `$name` Returns mixed
`public MvcCore\Ext\Forms\Field`	# `__set( string $name, mixed $value )` Universal setter, if property not defined - it's automatically declared. Universal setter, if property not defined - it's automatically declared. Parameters `$name` `$value` Returns `MvcCore\Ext\Forms\Field`
`public MvcCore\Ext\Forms\Field`	# `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. 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. Parameters `$form` Returns `MvcCore\Ext\Forms\Field` Throws InvalidArgumentException Implementation of `MvcCore\Ext\Forms\IField::SetForm()`
`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. 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. Implementation of `MvcCore\Ext\Forms\IField::PreDispatch()`
`public string\|integer\|array\|null`	# `Submit( array & $rawRequestParams = [] )` This INTERNAL method is called from `\MvcCore\Ext\Form` in submit processing. Do not use this method even if you don't develop form library or any form field. This INTERNAL method is called from `\MvcCore\Ext\Form` in submit processing. Do not use this method even if you don't develop form library or any form field. Submit field value - process raw request value with all configured validators and add errors into form if necessary. Then return safe processed value by all from validators or `NULL`. Parameters `$rawRequestParams` Raw request params from MvcCore request object based on raw app input, `$_GET` or `$_POST`. Returns string\|integer\|array\|null Implementation of `MvcCore\Ext\Forms\IField::Submit()`
`public array &`	# `GetValidatorData( array $fieldPropsDefaultValidValues = [] )` Default implementation for any extended field class to get field specific data for validator purposes. If you want to extend any field, you could implement this method better and faster. It's only necessary in your implementation to return array with keys to be field specific properties in camel case and values to be field properties values, which validator requires. Default implementation for any extended field class to get field specific data for validator purposes. If you want to extend any field, you could implement this method better and faster. It's only necessary in your implementation to return array with keys to be field specific properties in camel case and values to be field properties values, which validator requires. Parameters `$fieldPropsDefaultValidValues` Returns array Implementation of `MvcCore\Ext\Forms\IField::GetValidatorData()`
`public MvcCore\Ext\Forms\Field`	# `AddValidationError( string $errorMsg = '', array $errorMsgArgs = [], callable $replacingCallable = NULL )` This INTERNAL method is called from `\MvcCore\Ext\Forms\Field` in submit processing. Do not use this method even if you don't develop any form field or field validator. This INTERNAL method is called from `\MvcCore\Ext\Forms\Field` in submit processing. Do not use this method even if you don't develop any form field or field validator. Add form error with given error message containing possible replacements for array values. If there is necessary to translate form elements (form has configured property `translator` as `callable`) than given error message is translated first before replacing. Before error message processing for replacements, there is automatically assigned into first position into `$errorMsgArgs` array (translated) field label or field name and than error message is processed for replacements. If there is given some custom `$replacingCallable` param, error message is processed for replacements by custom `$replacingCallable`. If there is not given any custom `$replacingCallable` param, error message is processed for replacements by static `Format()` method by configured form view class. Parameters `$errorMsg` `$errorMsgArgs` `$replacingCallable` Returns `MvcCore\Ext\Forms\Field` Implementation of `MvcCore\Ext\Forms\IField::AddValidationError()`
`protected string`	# `translateAndFormatValidationError( string $errorMsg = '', array $errorMsgArgs = [], callable $replacingCallable = NULL )` Format form error with given error message containing possible replacements for array values. Format form error with given error message containing possible replacements for array values. If there is necessary to translate form elements (form has configured property `translator` as `callable`) than given error message is translated first before replacing. Before error message processing for replacements, there is automatically assigned into first position into `$errorMsgArgs` array (translated) field label or field name and than error message is processed for replacements. If there is given some custom `$replacingCallable` param, error message is processed for replacements by custom `$replacingCallable`. If there is not given any custom `$replacingCallable` param, error message is processed for replacements by static `Format()` method by configured form view class. Parameters `$errorMsg` `$errorMsgArgs` `$replacingCallable` Returns string
`protected`	# `throwNewInvalidArgumentException( string $errorMsg )` Throw new `\InvalidArgumentException` with given error message and append automatically current class name, current form id, form class type and current field class type. Throw new `\InvalidArgumentException` with given error message and append automatically current class name, current form id, form class type and current field class type. Parameters `$errorMsg` Throws InvalidArgumentException

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

Methods used from MvcCore\Ext\Forms\Field\Getters
`GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetTranslate(), GetType(), GetValidators(), GetValue(), 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(), SetValue(), SetViewScript()`

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

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 used from MvcCore\Ext\Forms\Field\Props
`$controlAttrs, $cssClasses, $cssSupportingFile, $declaredProtectedProperties, $errors, $form, $id, $jsClassName, $jsSupportingFile, $name, $templates, $title, $translate, $translateTitle, $type, $validators, $value, $view, $viewScript`

Classes

Interfaces

Traits

Exceptions

Functions

Class Field

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Throws

Implementation of

Parameters

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Implementation of

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Throws