Class yii\widgets\ActiveField

All Classes | Properties | Methods

Inheritance	yii\widgets\ActiveField » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Subclasses	yii\bootstrap\ActiveField, yii\gii\components\ActiveField
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/widgets/ActiveField.php

ActiveField represents a form input field within an yii\widgets\ActiveForm.

For more details and usage information on ActiveField, see the guide article on forms.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$addAriaAttributes	boolean	Adds aria HTML attributes `aria-required` and `aria-invalid` for inputs	yii\widgets\ActiveField
$attribute	string	The model attribute that this field is associated with.	yii\widgets\ActiveField
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component. This property is read-only.	yii\base\Component
$enableAjaxValidation	boolean	Whether to enable AJAX-based data validation.	yii\widgets\ActiveField
$enableClientValidation	boolean	Whether to enable client-side data validation.	yii\widgets\ActiveField
$errorOptions	array	The default options for the error tags.	yii\widgets\ActiveField
$form	yii\widgets\ActiveForm	The form that this field is associated with.	yii\widgets\ActiveField
$hintOptions	array	The default options for the hint tags.	yii\widgets\ActiveField
$inputOptions	array	The default options for the input tags.	yii\widgets\ActiveField
$labelOptions	array	The default options for the label tags.	yii\widgets\ActiveField
$model	yii\base\Model	The data model that this field is associated with.	yii\widgets\ActiveField
$options	array	The HTML attributes (name-value pairs) for the field container tag.	yii\widgets\ActiveField
$parts	array	Different parts of the field (e.g. input, label).	yii\widgets\ActiveField
$selectors	array	The jQuery selectors for selecting the container, input and error tags.	yii\widgets\ActiveField
$template	string	The template that is used to arrange the label, the input field, the error message and the hint text.	yii\widgets\ActiveField
$validateOnBlur	boolean	Whether to perform validation when the input field loses focus.	yii\widgets\ActiveField
$validateOnChange	boolean	Whether to perform validation when the value of the input field is changed.	yii\widgets\ActiveField
$validateOnType	boolean	Whether to perform validation while the user is typing in the input field.	yii\widgets\ActiveField
$validationDelay	integer	Number of milliseconds that the validation should be delayed when the user types in the field and $validateOnType is set `true`.	yii\widgets\ActiveField

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__toString()	PHP magic method that returns the string representation of this object.	yii\widgets\ActiveField
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
begin()	Renders the opening tag of the field container.	yii\widgets\ActiveField
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
checkbox()	Renders a checkbox.	yii\widgets\ActiveField
checkboxList()	Renders a list of checkboxes.	yii\widgets\ActiveField
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
dropDownList()	Renders a drop-down list.	yii\widgets\ActiveField
end()	Renders the closing tag of the field container.	yii\widgets\ActiveField
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
error()	Generates a tag that contains the first validation error of $attribute.	yii\widgets\ActiveField
fileInput()	Renders a file input.	yii\widgets\ActiveField
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
hiddenInput()	Renders a hidden input.	yii\widgets\ActiveField
hint()	Renders the hint tag.	yii\widgets\ActiveField
init()	Initializes the object.	yii\base\BaseObject
input()	Renders an input tag.	yii\widgets\ActiveField
label()	Generates a label tag for $attribute.	yii\widgets\ActiveField
listBox()	Renders a list box.	yii\widgets\ActiveField
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
passwordInput()	Renders a password input.	yii\widgets\ActiveField
radio()	Renders a radio button.	yii\widgets\ActiveField
radioList()	Renders a list of radio buttons.	yii\widgets\ActiveField
render()	Renders the whole field.	yii\widgets\ActiveField
textInput()	Renders a text input.	yii\widgets\ActiveField
textarea()	Renders a text area.	yii\widgets\ActiveField
trigger()	Triggers an event.	yii\base\Component
widget()	Renders a widget as the input of the field.	yii\widgets\ActiveField

Protected Methods

Hide inherited methods

Method	Description	Defined By
addAriaAttributes()	Adds aria attributes to the input options.	yii\widgets\ActiveField
addErrorClassIfNeeded()	Adds validation class to the input options if needed.	yii\widgets\ActiveField
addRoleAttributes()	Add role attributes to the input options	yii\widgets\ActiveField
adjustLabelFor()	Adjusts the `for` attribute for the label based on the input options.	yii\widgets\ActiveField
getClientOptions()	Returns the JS options for the field.	yii\widgets\ActiveField
getInputId()	Returns the HTML `id` of the input element of this form field.	yii\widgets\ActiveField
isAjaxValidationEnabled()	Checks if ajax validation enabled for the field.	yii\widgets\ActiveField
isClientValidationEnabled()	Checks if client validation enabled for the field.	yii\widgets\ActiveField

Property Details

$addAriaAttributes public property (available since version 2.0.11)

Adds aria HTML attributes aria-required and aria-invalid for inputs

public boolean $addAriaAttributes = true

$attribute public property

The model attribute that this field is associated with.

public string $attribute = null

$enableAjaxValidation public property

Whether to enable AJAX-based data validation. If not set, it will take the value of yii\widgets\ActiveForm::$enableAjaxValidation.

public boolean $enableAjaxValidation = null

$enableClientValidation public property

Whether to enable client-side data validation. If not set, it will take the value of yii\widgets\ActiveForm::$enableClientValidation.

public boolean $enableClientValidation = null

$errorOptions public property

The default options for the error tags. The parameter passed to error() will be merged with this property when rendering the error tag. The following special options are recognized:

tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().
encode: whether to encode the error output. Defaults to true.

If you set a custom id for the error element, you may need to adjust the $selectors accordingly.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $errorOptions = ['class' => 'help-block']

$form public property

The form that this field is associated with.

public yii\widgets\ActiveForm $form = null

$hintOptions public property

The default options for the hint tags. The parameter passed to hint() will be merged with this property when rendering the hint tag. The following special options are recognized:

tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $hintOptions = ['class' => 'hint-block']

$inputOptions public property

The default options for the input tags. The parameter passed to individual input methods (e.g. textInput()) will be merged with this property when rendering the input tag.

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $inputOptions = ['class' => 'form-control']

$labelOptions public property

The default options for the label tags. The parameter passed to label() will be merged with this property when rendering the label tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $labelOptions = ['class' => 'control-label']

$model public property

The data model that this field is associated with.

public yii\base\Model $model = null

$options public property

The HTML attributes (name-value pairs) for the field container tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is null, the corresponding attribute will not be rendered. The following special options are recognized:

tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().

If you set a custom id for the container element, you may need to adjust the $selectors accordingly.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = ['class' => 'form-group']

$parts public property

Different parts of the field (e.g. input, label). This will be used together with $template to generate the final field HTML code. The keys are the token names in $template, while the values are the corresponding HTML code. Valid tokens include {input}, {label} and {error}. Note that you normally don't need to access this property directly as it is maintained by various methods of this class.

public array $parts = []

$selectors public property

The jQuery selectors for selecting the container, input and error tags. The array keys should be container, input, and/or error, and the array values are the corresponding selectors. For example, ['input' => '#my-input'].

The container selector is used under the context of the form, while the input and the error selectors are used under the context of the container.

You normally do not need to set this property as the default selectors should work well for most cases.

public array $selectors = []

$template public property

The template that is used to arrange the label, the input field, the error message and the hint text. The following tokens will be replaced when render() is called: {label}, {input}, {error} and {hint}.

public string $template = "{label}\n{input}\n{hint}\n{error}"

$validateOnBlur public property

Whether to perform validation when the input field loses focus. If not set, it will take the value of yii\widgets\ActiveForm::$validateOnBlur.

public boolean $validateOnBlur = null

$validateOnChange public property

Whether to perform validation when the value of the input field is changed. If not set, it will take the value of yii\widgets\ActiveForm::$validateOnChange.

public boolean $validateOnChange = null

$validateOnType public property

Whether to perform validation while the user is typing in the input field. If not set, it will take the value of yii\widgets\ActiveForm::$validateOnType.

Method Details

__toString() public method

PHP magic method that returns the string representation of this object.

public string __toString ( )
return	string	The string representation of this object.

addAriaAttributes() protected method (available since version 2.0.11)

Adds aria attributes to the input options.

protected void addAriaAttributes ( &$options )
$options		Array input options

addErrorClassIfNeeded() protected method (available since version 2.0.14)

Adds validation class to the input options if needed.

protected void addErrorClassIfNeeded ( &$options )
$options		Array input options

addRoleAttributes() protected method (available since version 2.0.16)

Add role attributes to the input options

protected void addRoleAttributes ( &$options, $role )
$options		Array input options
$role	string

adjustLabelFor() protected method

Adjusts the for attribute for the label based on the input options.

protected void adjustLabelFor ( $options )
$options	array	The input options.

begin() public method

Renders the opening tag of the field container.

public string begin ( )
return	string	The rendering result.

checkbox() public method

Renders a checkbox.

This method will generate the checked tag attribute according to the model attribute value.

public $this checkbox ( $options = [], $enclosedByLabel = true )
$options	array	The tag options in terms of name-value pairs. The following options are specially handled: `uncheck`: string, the value associated with the uncheck state of the radio button. If not set, it will take the default value `0`. This method will render a hidden input so that if the radio button is not checked and is submitted, the value of this attribute will still be submitted to the server via the hidden input. If you do not want any hidden input, you should explicitly set this option as `null`. `label`: string, a label displayed next to the checkbox. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is coming from end users, you should encode it to prevent XSS attacks. When this option is specified, the checkbox will be enclosed by a label tag. If you do not want any label, you should explicitly set this option as `null`. `labelOptions`: array, the HTML attributes for the label tag. This is only used when the `label` option is specified. The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is `null`, the corresponding attribute will not be rendered. If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
$enclosedByLabel	boolean	Whether to enclose the checkbox within the label. If `true`, the method will still use $template to layout the checkbox and the error message except that the checkbox is enclosed by the label tag.
return	$this	The field object itself.

checkboxList() public method

Renders a list of checkboxes.

A checkbox list allows multiple selection, like listBox(). As a result, the corresponding submitted value is an array. The selection of the checkbox list is taken from the value of the model attribute.

public $this checkboxList ( $items, $options = [] )
$items	array	The data item used to generate the checkboxes. The array values are the labels, while the array keys are the corresponding checkbox values.
$options	array	Options (name => config) for the checkbox list. For the list of available options please refer to the `$options` parameter of yii\helpers\Html::activeCheckboxList().
return	$this	The field object itself.

dropDownList() public method

Renders a drop-down list.

The selection of the drop-down list is taken from the value of the model attribute.

public $this dropDownList ( $items, $options = [] )
$items	array	The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using yii\helpers\ArrayHelper::map(). Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded.
$options	array	The tag options in terms of name-value pairs. For the list of available options please refer to the `$options` parameter of yii\helpers\Html::activeDropDownList(). If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

end() public method

Renders the closing tag of the field container.

public string end ( )
return	string	The rendering result.

error() public method

Generates a tag that contains the first validation error of $attribute.

Note that even if there is no validation error, this method will still return an empty error tag.

See also $errorOptions.

public $this error ( $options = [] )
$options	array\|false	The tag options in terms of name-value pairs. It will be merged with $errorOptions. The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If this parameter is `false`, no error tag will be rendered. The following options are specially handled: `tag`: this specifies the tag name. If not set, `div` will be used. See also yii\helpers\Html::tag(). If you set a custom `id` for the error element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

fileInput() public method

Renders a file input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this fileInput ( $options = [] )
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

getClientOptions() protected method

Returns the JS options for the field.

protected array getClientOptions ( )
return	array	The JS options.

getInputId() protected method (available since version 2.0.7)

Returns the HTML id of the input element of this form field.

protected string getInputId ( )
return	string	The input id.

hiddenInput() public method

Renders a hidden input.

Note that this method is provided for completeness. In most cases because you do not need to validate a hidden input, you should not need to use this method. Instead, you should use yii\helpers\Html::activeHiddenInput().

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this hiddenInput ( $options = [] )
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

hint() public method

Renders the hint tag.

public $this hint ( $content, $options = [] )
$content	string\|boolean	The hint content. If `null`, the hint will be generated via yii\base\Model::getAttributeHint(). If `false`, the generated field will not contain the hint part. Note that this will NOT be encoded.
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the hint tag. The values will be HTML-encoded using yii\helpers\Html::encode(). The following options are specially handled: `tag`: this specifies the tag name. If not set, `div` will be used. See also yii\helpers\Html::tag().
return	$this	The field object itself.

input() public method

Renders an input tag.

public $this input ( $type, $options = [] )
$type	string	The input type (e.g. `text`, `password`)
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

isAjaxValidationEnabled() protected method (available since version 2.0.11)

Checks if ajax validation enabled for the field.

protected boolean isAjaxValidationEnabled ( )

isClientValidationEnabled() protected method (available since version 2.0.11)

Checks if client validation enabled for the field.

protected boolean isClientValidationEnabled ( )

label() public method

Generates a label tag for $attribute.

public $this label ( $label = null, $options = [] )
$label	null\|string\|false	The label to use. If `null`, the label will be generated via yii\base\Model::getAttributeLabel(). If `false`, the generated field will not contain the label part. Note that this will NOT be encoded.
$options	null\|array	The tag options in terms of name-value pairs. It will be merged with $labelOptions. The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is `null`, the corresponding attribute will not be rendered.
return	$this	The field object itself.

listBox() public method

Renders a list box.

The selection of the list box is taken from the value of the model attribute.

public $this listBox ( $items, $options = [] )
$items	array	The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using yii\helpers\ArrayHelper::map(). Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded.
$options	array	The tag options in terms of name-value pairs. For the list of available options please refer to the `$options` parameter of yii\helpers\Html::activeListBox(). If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

passwordInput() public method

Renders a password input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this passwordInput ( $options = [] )
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

radio() public method

Renders a radio button.

This method will generate the checked tag attribute according to the model attribute value.

public $this radio ( $options = [], $enclosedByLabel = true )
$options	array	The tag options in terms of name-value pairs. The following options are specially handled: `uncheck`: string, the value associated with the uncheck state of the radio button. If not set, it will take the default value `0`. This method will render a hidden input so that if the radio button is not checked and is submitted, the value of this attribute will still be submitted to the server via the hidden input. If you do not want any hidden input, you should explicitly set this option as `null`. `label`: string, a label displayed next to the radio button. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is coming from end users, you should encode it to prevent XSS attacks. When this option is specified, the radio button will be enclosed by a label tag. If you do not want any label, you should explicitly set this option as `null`. `labelOptions`: array, the HTML attributes for the label tag. This is only used when the `label` option is specified. The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is `null`, the corresponding attribute will not be rendered. If you set a custom `id` for the input element, you may need to adjust the $selectors accordingly.
$enclosedByLabel	boolean	Whether to enclose the radio within the label. If `true`, the method will still use $template to layout the radio button and the error message except that the radio is enclosed by the label tag.
return	$this	The field object itself.

radioList() public method

Renders a list of radio buttons.

A radio button list is like a checkbox list, except that it only allows single selection. The selection of the radio buttons is taken from the value of the model attribute.

public $this radioList ( $items, $options = [] )
$items	array	The data item used to generate the radio buttons. The array values are the labels, while the array keys are the corresponding radio values.
$options	array	Options (name => config) for the radio button list. For the list of available options please refer to the `$options` parameter of yii\helpers\Html::activeRadioList().
return	$this	The field object itself.

render() public method

Renders the whole field.

This method will generate the label, error tag, input tag and hint tag (if any), and assemble them into HTML according to $template.

public string render ( $content = null )
$content	string\|callable	The content within the field container. If `null` (not set), the default methods will be called to generate the label, error tag and input tag, and use them as the content. If a callable, it will be called to generate the content. The signature of the callable should be: `function ($field) { return $html; }`
return	string	The rendering result.

textInput() public method

Renders a text input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this textInput ( $options = [] )
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). The following special options are recognized: `maxlength`: int\|bool, when `maxlength` is set `true` and the model attribute is validated by a string validator, the `maxlength` option will take the value of yii\validators\StringValidator::$max. This is available since version 2.0.3. Note that if you set a custom `id` for the input element, you may need to adjust the value of $selectors accordingly.
return	$this	The field object itself.

textarea() public method

Renders a text area.

The model attribute value will be used as the content in the textarea.

public $this textarea ( $options = [] )
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If you set a custom `id` for the textarea element, you may need to adjust the $selectors accordingly.
return	$this	The field object itself.

widget() public method

Renders a widget as the input of the field.

Note that the widget must have both model and attribute properties. They will be initialized with $model and $attribute of this field, respectively.

If you want to use a widget that does not have model and attribute properties, please use render() instead.

While widgets extending from yii\base\Widget work with active field, it is preferred to use yii\widgets\InputWidget as a base class.

For example to use the yii\widgets\MaskedInput widget to get some date input, you can use the following code, assuming that $form is your yii\widgets\ActiveForm instance:

$form->field($model, 'date')->widget(\yii\widgets\MaskedInput::className(), [
    'mask' => '99/99/9999',
]);

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

public $this widget ( $class, $config = [] )
$class	string	The widget class name.
$config	array	Name-value pairs that will be used to initialize the widget.
return	$this	The field object itself.
throws	Exception