# Class yii\gii\components\ActiveField

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

## 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\gii\Generator |  | yii\gii\components\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\gii\components\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
autoComplete() | Makes field auto completable | yii\gii\components\ActiveField
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\gii\components\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\gii\components\ActiveField
init() | Initializes the object. | yii\gii\components\ActiveField
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\gii\components\ActiveField
radioList() | Renders a list of radio buttons. | yii\widgets\ActiveField
render() | Renders the whole field. | yii\widgets\ActiveField
sticky() | Makes field remember its value between page reloads | yii\gii\components\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

$model public property
public yii\gii\Generator $model = null
$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{list}\n{error}"

## Method Details

autoComplete() public method

Makes field auto completable

public $this autoComplete ( $data )
$data | array | Auto complete data (array of callables or scalars)
return | $this | The field object itself

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 = false )

$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.

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.

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

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 = false )

$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.

sticky() public method

Makes field remember its value between page reloads

public $this sticky ( )
return | $this | The field object itself