| Property | Type | Description | |
|---|---|---|---|
| $attribute | the model attribute that this field is associated with. | ||
| $enableAjaxValidation | whether to enable AJAX-based data validation. If not set, it will take the value of [[ActiveForm::enableAjaxValidation]]. | ||
| $enableClientValidation | whether to enable client-side data validation. If not set, it will take the value of [[ActiveForm::enableClientValidation]]. | ||
| $errorOptions | the default options for the error tags. The parameter passed to ActiveField::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. | ||
| $form | the form that this field is associated with. | ||
| $hintOptions | the default options for the hint tags. The parameter passed to ActiveField::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()]]. | ||
| $inputOptions | the default options for the input tags. The parameter passed to individual input methods (e.g. ActiveField::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. | ||
| $labelOptions | the default options for the label tags. The parameter passed to ActiveField::label will be merged with this property when rendering the label tag. | ||
| $model | the data model that this field is associated with. | ||
| $options | the HTML attributes (name-value pairs) for the field container tag. The values will be HTML-encoded using [[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. | ||
| $parts | 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. | ||
| $selectors | 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. | ||
| $template | 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 ActiveField::render is called: {label}, {input}, {error} and {hint}. | ||
| $validateOnBlur | whether to perform validation when the input field loses focus. If not set, it will take the value of [[ActiveForm::validateOnBlur]]. | ||
| $validateOnChange | whether to perform validation when the value of the input field is changed. If not set, it will take the value of [[ActiveForm::validateOnChange]]. | ||
| $validateOnType | whether to perform validation while the user is typing in the input field. If not set, it will take the value of [[ActiveForm::validateOnType]]. | ||
| $validationDelay | number of milliseconds that the validation should be delayed when the user types in the field and [[validateOnType]] is set true. If not set, it will take the value of [[ActiveForm::validationDelay]]. |
| Method | Description | |
|---|---|---|
| __toString ( ) : string | PHP magic method that returns the string representation of this object. | |
| begin ( ) : string | Renders the opening tag of the field container. | |
| checkbox ( array $options = [], boolean $enclosedByLabel = true ) | Renders a checkbox. | |
| checkboxList ( array $items, array $options = [] ) | Renders a list of checkboxes. | |
| dropDownList ( array $items, array $options = [] ) | Renders a drop-down list. | |
| end ( ) : string | Renders the closing tag of the field container. | |
| error ( array | false $options = [] ) | Generates a tag that contains the first validation error of [[attribute]]. | |
| fileInput ( array $options = [] ) | Renders a file input. | |
| hiddenInput ( array $options = [] ) | Renders a hidden input. | |
| hint ( string | boolean $content, array $options = [] ) | Renders the hint tag. | |
| input ( string $type, array $options = [] ) | Renders an input tag. | |
| label ( null | string | false $label = null, null | array $options = [] ) | Generates a label tag for [[attribute]]. | |
| listBox ( array $items, array $options = [] ) | Renders a list box. | |
| passwordInput ( array $options = [] ) | Renders a password input. | |
| radio ( array $options = [], boolean $enclosedByLabel = true ) | Renders a radio button. | |
| radioList ( array $items, array $options = [] ) | Renders a list of radio buttons. | |
| render ( string | callable $content = null ) : string | Renders the whole field. | |
| textInput ( array $options = [] ) | Renders a text input. | |
| textarea ( array $options = [] ) | Renders a text area. | |
| widget ( string $class, array $config = [] ) | Renders a widget as the input of the field. |
| Method | Description | |
|---|---|---|
| adjustLabelFor ( array $options ) | Adjusts the for attribute for the label based on the input options. | |
| getClientOptions ( ) : array | Returns the JS options for the field. | |
| getInputId ( ) : string | Returns the HTML id of the input element of this form field. |
| public __toString ( ) : string | ||
| return | string | the string representation of this object. |
| protected adjustLabelFor ( array $options ) | ||
| $options | array | the input options. |
| public checkbox ( array $options = [], boolean $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 [[Html::encode()|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 [[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. |
| public checkboxList ( array $items, array $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()]]. |
| public dropDownList ( array $items, array $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 [[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. |
| public error ( array | false $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 [[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. |
| public fileInput ( array $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 [[Html::encode()]]. If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. |
| protected getClientOptions ( ) : array | ||
| return | array | the JS options. |
| protected getInputId ( ) : string | ||
| return | string | the input id. |
| public hint ( string | boolean $content, array $options = [] ) | ||
| $content | string | boolean | the hint content. If `null`, the hint will be generated via [[Model::getAttributeHint()]]. If `false`, the generated field will not contain the hint part. Note that this will NOT be [[Html::encode()|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 [[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()]]. |
| public input ( string $type, array $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 [[Html::encode()]]. If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. |
| public label ( null | string | false $label = null, null | array $options = [] ) | ||
| $label | null | string | false | the label to use. If `null`, the label will be generated via [[Model::getAttributeLabel()]]. If `false`, the generated field will not contain the label part. Note that this will NOT be [[Html::encode()|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 [[Html::encode()]]. If a value is `null`, the corresponding attribute will not be rendered. |
| public listBox ( array $items, array $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. |
| public passwordInput ( array $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 [[Html::encode()]]. If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly. |
| public radio ( array $options = [], boolean $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 [[Html::encode()|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 [[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. |
| public radioList ( array $items, array $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()]]. |
| public render ( string | callable $content = null ) : string | ||
| $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: ```php function ($field) { return $html; } ``` |
| return | string | the rendering result. |
| public textInput ( array $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 [[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. |
| public textarea ( array $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 [[Html::encode()]]. If you set a custom `id` for the textarea element, you may need to adjust the [[$selectors]] accordingly. |
| public $attribute |
| public $enableAjaxValidation |
| public $enableClientValidation |
| public $errorOptions |
| public $hintOptions |
| public $inputOptions |
| public $labelOptions |
| public $options |
| public $parts |
| public $selectors |
| public $template |
| public $validateOnBlur |
| public $validateOnChange |
| public $validateOnType |