Класс yii\widgets\ActiveField

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

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.

public $this dropDownList ( $items, $options = [] )

$items

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

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

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.

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.

public $this fileInput ( $options = [] )

$options

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

The field object itself.

getClientOptions() protected method

Returns the JS options for the field.

protected массив getClientOptions ( )
возвращает	массив	Параметры JS.

getInputId() защищённый метод (доступен с версии 2.0.7)

Возвращает HTML id элемента ввода данного поля формы.

protected строка getInputId ( )
возвращает	строка	Идентификатор ввода.

hiddenInput() публичный метод

Отображает скрытый элемент ввода.

Обратите внимание, что этот метод предоставлен для полноты. В большинстве случаев, так как вам не нужно проверять скрытый элемент ввода, вам не следует использовать этот метод. Вместо этого вы должны использовать yii\helpers\Html::activeHiddenInput().

Этот метод будет генерировать name и value атрибуты тега автоматически для атрибута модели, если они не указаны явно в $options.

public $this hiddenInput ( $options = [] )
$options	массив	Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если вы зададите пользовательские `id` для элемента ввода, вам может потребоваться соответствующим образом настроить $selectors.
возвращает	$this	Сам объект поля.

public $this hiddenInput ( $options = [] )

$options

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode().

Если вы зададите пользовательские id для элемента ввода, вам может потребоваться соответствующим образом настроить $selectors.

возвращает

Сам объект поля.

hint() публичный метод

Отображает тег подсказки.

public $this hint ( $content, $options = [] )
$content	строка\|булево	Содержимое подсказки. Если `null`, подсказка будет сгенерирована через yii\base\Model::getAttributeHint(). Если `false`, сгенерированное поле не будет содержать часть подсказки. Обратите внимание, что это НЕ будет закодировано.
$options	массив	Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты тега подсказки. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Следующие параметры обрабатываются особо: `tag`: это указывает имя тега. Если не задано, будет использоваться `div`. См. также yii\helpers\Html::tag().
возвращает	$this	Сам объект поля.

public $this hint ( $content, $options = [] )

$content

строка|булево

Содержимое подсказки. Если null, подсказка будет сгенерирована через yii\base\Model::getAttributeHint(). Если false, сгенерированное поле не будет содержать часть подсказки. Обратите внимание, что это НЕ будет закодировано.

$options

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты тега подсказки. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode().

Следующие параметры обрабатываются особо:

tag: это указывает имя тега. Если не задано, будет использоваться div. См. также yii\helpers\Html::tag().

возвращает

Сам объект поля.

input() публичный метод

Отображает тег ввода.

public $this input ( $type, $options = [] )
$type	строка	Тип ввода (например, `text`, `password`)
$options	массив	Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если вы зададите пользовательские `id` для элемента ввода, вам может потребоваться соответствующим образом настроить $selectors.
возвращает	$this	Сам объект поля.

public $this input ( $type, $options = [] )

$type

строка

Тип ввода (например, text, password)

$options

возвращает

Сам объект поля.

isAjaxValidationEnabled() защищённый метод (доступен с версии 2.0.11)

Проверяет, включена ли AJAX-валидация для поля

protected булево isAjaxValidationEnabled ( )

isClientValidationEnabled() защищённый метод (доступен с версии 2.0.11)

Проверяет, включена ли клиентская валидация для поля

protected булево isClientValidationEnabled ( )

label() публичный метод

Генерирует тег метки для $attribute.

public $this label ( $label = null, $options = [] )
$label	null\|строка\|false	Используемая метка. Если `null`, метка будет сгенерирована через yii\base\Model::getAttributeLabel(). Если `false`, сгенерированное поле не будет содержать часть метки. Обратите внимание, что это НЕ будет закодировано.
$options	null\|массив	Параметры тега в виде пар имя-значение. Они будут объединены с $labelOptions. Параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если значение `null`, соответствующий атрибут не будет отображён.
возвращает	$this	Сам объект поля.

listBox() публичный метод

Отображает выпадающий список.

Выбор выпадающего списка берется из значения атрибута модели.

public $this listBox ( $items, $options = [] )
$items	массив	Элементы данных списка. Ключами массива являются значения опций, а значениями — соответствующие метки опций. Массив также может быть вложенным (т.е. некоторые значения массива тоже являются массивами). Для каждого подмассива будет сгенерирована группа опций, метка которой является ключом, связанным с подмассивом. Если у вас есть список моделей данных, вы можете преобразовать их в указанный выше формат, используя yii\helpers\ArrayHelper::map(). Обратите внимание, что значения и метки автоматически кодируются в HTML этим методом, а пробелы в метках также кодируются в HTML.
$options	массив	Параметры тега в виде пар имя-значение. Список доступных параметров см. в параметре `$options` yii\helpers\Html::activeListBox(). Если вы зададите пользовательские `id` для элемента ввода, вам может потребоваться соответствующим образом настроить $selectors.
возвращает	$this	Сам объект поля.

public $this listBox ( $items, $options = [] )

$items

Элементы данных списка. Ключами массива являются значения опций, а значениями — соответствующие метки опций. Массив также может быть вложенным (т.е. некоторые значения массива тоже являются массивами). Для каждого подмассива будет сгенерирована группа опций, метка которой является ключом, связанным с подмассивом. Если у вас есть список моделей данных, вы можете преобразовать их в указанный выше формат, используя yii\helpers\ArrayHelper::map().

Обратите внимание, что значения и метки автоматически кодируются в HTML этим методом, а пробелы в метках также кодируются в HTML.

$options

Параметры тега в виде пар имя-значение.

Список доступных параметров см. в параметре $options yii\helpers\Html::activeListBox().

возвращает

Сам объект поля.

passwordInput() публичный метод

Отображает поле ввода пароля.

public $this passwordInput ( $options = [] )
$options	массив	Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если вы зададите пользовательские `id` для элемента ввода, вам может потребоваться соответствующим образом настроить $selectors.
возвращает	$this	Сам объект поля.

public $this passwordInput ( $options = [] )

$options

возвращает

Сам объект поля.

radio() публичный метод

Отображает переключатель.

Этот метод сгенерирует атрибут тега checked в соответствии со значением атрибута модели.

public $this radio ( $options = [], $enclosedByLabel = true )
$options	массив	Параметры тега в формате имя-значение. Следующие параметры обрабатываются особенно: `uncheck`: строка, значение, соответствующее неотмеченному состоянию радиокнопки. Если не задано, используется значение по умолчанию `0`. Этот метод отобразит скрытый элемент ввода, так что если радиокнопка не отмечена и отправлена, значение этого атрибута всё равно будет отправлено на сервер через скрытый элемент ввода. Если вам не нужен скрытый элемент ввода, необходимо явно задать этот параметр как `null`. `label`: строка, метка, отображаемая рядом с радиокнопкой. Она НЕ будет закодирована в HTML. Поэтому вы можете передать HTML-код, например, тег изображения. Если это значение получено от конечного пользователя, вы должны закодировать его для предотвращения атак XSS. Если этот параметр указан, радиокнопка будет заключена в тег метки. Если вы не хотите метки, необходимо явно задать этот параметр как `null`. `labelOptions`: массив, атрибуты тега метки. Используется только при указании параметра `label`. Остальные параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если значение равно `null`, соответствующий атрибут не будет отображён. Если вы задали пользовательское значение `id` для элемента ввода, вам может потребоваться скорректировать $selectors.
$enclosedByLabel	булево	Определяет, следует ли заключать радиокнопку в метку. Если `true`, метод по-прежнему будет использовать $template для вывода радиокнопки и сообщения об ошибке, за исключением того, что радиокнопка будет заключена в тег метки.
return	$this	Объект самого поля.

public $this radio ( $options = [], $enclosedByLabel = true )

$options

Параметры тега в формате имя-значение. Следующие параметры обрабатываются особенно:

uncheck: строка, значение, соответствующее неотмеченному состоянию радиокнопки. Если не задано, используется значение по умолчанию 0. Этот метод отобразит скрытый элемент ввода, так что если радиокнопка не отмечена и отправлена, значение этого атрибута всё равно будет отправлено на сервер через скрытый элемент ввода. Если вам не нужен скрытый элемент ввода, необходимо явно задать этот параметр как null.
label: строка, метка, отображаемая рядом с радиокнопкой. Она НЕ будет закодирована в HTML. Поэтому вы можете передать HTML-код, например, тег изображения. Если это значение получено от конечного пользователя, вы должны закодировать его для предотвращения атак XSS. Если этот параметр указан, радиокнопка будет заключена в тег метки. Если вы не хотите метки, необходимо явно задать этот параметр как null.
labelOptions: массив, атрибуты тега метки. Используется только при указании параметра label.

Остальные параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если значение равно null, соответствующий атрибут не будет отображён.

Если вы задали пользовательское значение id для элемента ввода, вам может потребоваться скорректировать $selectors.

$enclosedByLabel

булево

Определяет, следует ли заключать радиокнопку в метку. Если true, метод по-прежнему будет использовать $template для вывода радиокнопки и сообщения об ошибке, за исключением того, что радиокнопка будет заключена в тег метки.

return

Объект самого поля.

radioList() public method

Отображает список радиокнопок.

Список радиокнопок похож на список флажков, за исключением того, что позволяет выбирать только один элемент. Выбор радиокнопок определяется значением атрибута модели.

public $this radioList ( $items, $options = [] )
$items	массив	Данные, используемые для генерации радиокнопок. Значения массива — метки, а ключи массива — соответствующие значения радиокнопок.
$options	массив	Параметры (имя => конфигурация) для списка радиокнопок. Список доступных параметров см. в параметре `$options` метода yii\helpers\Html::activeRadioList().
return	$this	Объект самого поля.

render() public method

Отображает всё поле.

Этот метод сгенерирует метку, тег ошибки, тег элемента ввода и тег подсказки (если есть), соберет их в HTML согласно $template.

public строка render ( $content = null )
$content	строка\|вызов функции	Содержимое внутри контейнера поля. Если `null` (не задано), будут вызваны стандартные методы для генерации метки, тега ошибки и тега элемента ввода, которые будут использованы как содержимое. Если передана функция, она будет вызвана для генерации содержимого. Подпись вызываемой функции должна быть: function ($field) { return $html; }
return	строка	Результат отображения.

public строка render ( $content = null )

$content

строка|вызов функции

Содержимое внутри контейнера поля. Если null (не задано), будут вызваны стандартные методы для генерации метки, тега ошибки и тега элемента ввода, которые будут использованы как содержимое. Если передана функция, она будет вызвана для генерации содержимого. Подпись вызываемой функции должна быть:

function ($field) {
    return $html;
}

return

строка

Результат отображения.

textInput() public method

Отображает текстовое поле ввода.

Этот метод автоматически сгенерирует атрибуты тега name и value для атрибута модели, если они явно не указаны в $options.

public $this textInput ( $options = [] )
$options	массив	Параметры тега в формате имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Распознаются следующие специальные параметры: `maxlength`: int\|bool, когда `maxlength` установлен `true` и атрибут модели валидируется строковым валидатором, параметр `maxlength` получит значение из yii\validators\StringValidator::$max. Доступно начиная с версии 2.0.3. Обратите внимание, что если вы задали пользовательское значение `id` для элемента ввода, вам может потребоваться скорректировать значение $selectors.
return	$this	Объект самого поля.

public $this textInput ( $options = [] )

$options

Параметры тега в формате имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode().

Распознаются следующие специальные параметры:

maxlength: int|bool, когда maxlength установлен true и атрибут модели валидируется строковым валидатором, параметр maxlength получит значение из yii\validators\StringValidator::$max. Доступно начиная с версии 2.0.3.

Обратите внимание, что если вы задали пользовательское значение id для элемента ввода, вам может потребоваться скорректировать значение $selectors.

return

Объект самого поля.

textarea() public method

Отображает текстовую область.

Значение атрибута модели будет использовано в качестве содержимого в текстовой области.

public $this textarea ( $options = [] )
$options	массив	Параметры тега в формате имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью yii\helpers\Html::encode(). Если вы задали пользовательское значение `id` для элемента textarea, вам может потребоваться скорректировать $selectors.
return	$this	Объект самого поля.

public $this textarea ( $options = [] )

$options

Если вы задали пользовательское значение id для элемента textarea, вам может потребоваться скорректировать $selectors.

return