Класс yii\bootstrap\ActiveForm
| Наследование | yii\bootstrap\ActiveForm » yii\widgets\ActiveForm » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-bootstrap/blob/master/ActiveForm.php |
Улучшенная версия формы Bootstrap 3 класса yii\widgets\ActiveForm.
Этот класс в основном добавляет свойство $layout для выбора макета формы Bootstrap 3. Например, чтобы отобразить горизонтальную форму, необходимо:
use yii\bootstrap\ActiveForm; $form = ActiveForm::begin(['layout' => 'horizontal'])
Это установит значения по умолчанию для yii\bootstrap\ActiveField для отображения горизонтальных полей формы. В частности, шаблон template устанавливается в {label} {beginWrapper} {input} {error} {endWrapper} {hint} , а horizontalCssClasses устанавливаются в:
[
'offset' => 'col-sm-offset-3',
'label' => 'col-sm-3',
'wrapper' => 'col-sm-6',
'error' => '',
'hint' => 'col-sm-3',
]
Чтобы получить другой макет столбцов в горизонтальном режиме, можно изменить эти параметры через $fieldConfig:
$form = ActiveForm::begin([
'layout' => 'horizontal',
'fieldConfig' => [
'template' => "{label}\n{beginWrapper}\n{input}\n{hint}\n{error}\n{endWrapper}",
'horizontalCssClasses' => [
'label' => 'col-sm-4',
'offset' => 'col-sm-offset-4',
'wrapper' => 'col-sm-8',
'error' => '',
'hint' => '',
],
],
]);
См. также:
- yii\bootstrap\ActiveField для получения подробностей об опциях $fieldConfig.
- http://getbootstrap.com/css/#forms
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $action | массив|строка | URL действия формы. | yii\widgets\ActiveForm |
| $ajaxDataType | строка | Тип данных, ожидаемых от сервера. | yii\widgets\ActiveForm |
| $ajaxParam | строка | Имя параметра GET, указывающего, что запрос валидации является AJAX-запросом. | yii\widgets\ActiveForm |
| $attributes | массив | Параметры клиентской валидации для отдельных атрибутов. | yii\widgets\ActiveForm |
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $counter | целое число | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $enableAjaxValidation | булево | Включить AJAX-валидацию данных. | yii\widgets\ActiveForm |
| $enableClientScript | булево | Подключать `yii. | yii\widgets\ActiveForm |
| $enableClientValidation | булево | Включить клиентскую валидацию данных. | yii\widgets\ActiveForm |
| $encodeErrorSummary | булево | Выполнять кодирование сводки ошибок. | yii\widgets\ActiveForm |
| $errorCssClass | строка | CSS-класс, добавляемый к контейнеру поля, если у соответствующего атрибута есть ошибка валидации. | yii\widgets\ActiveForm |
| $errorSummaryCssClass | строка | Базовый CSS-класс для контейнера сводки ошибок. | yii\widgets\ActiveForm |
| $fieldClass | строка | Имя класса поля по умолчанию при вызове field() для создания нового поля. | yii\bootstrap\ActiveForm |
| $fieldConfig | массив|Closure | Конфигурация по умолчанию, используемая field() при создании нового объекта поля. | yii\widgets\ActiveForm |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $layout | строка | Макет формы. | yii\bootstrap\ActiveForm |
| $method | строка | Метод отправки формы. | yii\widgets\ActiveForm |
| $options | массив | Атрибуты HTML для тега формы. | yii\bootstrap\ActiveForm |
| $requiredCssClass | строка | CSS-класс, добавляемый к контейнеру поля, если соответствующий атрибут обязателен. | yii\widgets\ActiveForm |
| $scrollToError | булево | Прокручивать ли к первой ошибке после валидации. | yii\widgets\ActiveForm |
| $scrollToErrorOffset | целое число | Смещение в пикселях, которое должно быть добавлено при прокрутке к первой ошибке. | yii\widgets\ActiveForm |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент рендерятся (не завершены). | yii\base\Widget |
| $successCssClass | строка | CSS-класс, добавляемый к контейнеру поля, если соответствующий атрибут успешно валидирован. | yii\widgets\ActiveForm |
| $validateOnBlur | булево | Выполнять ли валидацию при потере фокуса полем ввода. | yii\widgets\ActiveForm |
| $validateOnChange | булево | Выполнять ли валидацию при изменении значения поля ввода. | yii\widgets\ActiveForm |
| $validateOnSubmit | булево | Выполнять ли валидацию при отправке формы. | yii\widgets\ActiveForm |
| $validateOnType | булево | Выполнять ли валидацию при вводе пользователем данных в поле. | yii\widgets\ActiveForm |
| $validatingCssClass | строка | CSS-класс, добавляемый к контейнеру поля во время валидации соответствующего атрибута. | yii\widgets\ActiveForm |
| $validationDelay | целое число | Число миллисекунд задержки валидации при вводе пользователем данных в поле и $validateOnType установлено true. | yii\widgets\ActiveForm |
| $validationUrl | массив|строка | URL для выполнения AJAX-валидации. | yii\widgets\ActiveForm |
| $view | yii\web\View | Объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| $viewPath | строка | Директория, содержащая файлы представлений для данного виджета. | yii\base\Widget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Прикрепляет поведение к компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается сразу перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает выполнение виджета. | yii\base\Widget |
| beginField() | Начинает выполнение поля формы. | yii\widgets\ActiveForm |
| behaviors() | Возвращает список поведений, по которым должен работать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли читать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает выполнение виджета. | yii\base\Widget |
| endField() | Завершает выполнение поля формы. | yii\widgets\ActiveForm |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| errorSummary() | Создаёт сводку ошибок валидации. | yii\widgets\ActiveForm |
| field() | Создаёт поле формы. | yii\bootstrap\ActiveForm |
| getBehavior() | Возвращает объект поведения с указанным именем. | yii\base\Component |
| getBehaviors() | Возвращает все прикреплённые к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикреплённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\bootstrap\ActiveForm |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| registerClientScript() | Регистрирует необходимый код JavaScript. | yii\widgets\ActiveForm |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\widgets\ActiveForm |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| validate() | Проверяет одно или несколько моделей и возвращает массив сообщений об ошибках, индексированных по идентификаторам атрибутов. | yii\widgets\ActiveForm |
| validateMultiple() | Проверяет массив экземпляров моделей и возвращает массив сообщений об ошибках, индексированных по идентификаторам атрибутов. | yii\widgets\ActiveForm |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getClientOptions() | Возвращает параметры для виджета формы JS. | yii\widgets\ActiveForm |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу перед выполнением виджета. (доступно с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает при инициализации виджета через init(). (доступно с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$fieldClass общедоступное свойство
Имя по умолчанию класса поля при вызове field() для создания нового поля.
См. также $fieldConfig.
public string $fieldClass = 'yii\bootstrap\ActiveField'
$layout общественное свойство
Макет формы. Может быть 'default', 'horizontal' или 'inline'. Выбор макета применяет соответствующую конфигурацию поля по умолчанию. Это отобразит поля формы с немного отличающейся разметкой для каждого макета. Вы можете переопределить эти значения по умолчанию с помощью $fieldConfig.
См. также yii\bootstrap\ActiveField для получения подробной информации о конфигурации поля Bootstrap 3.
public string $layout = 'default'
$options общественное свойство
Атрибуты HTML для тега формы. Значение по умолчанию [].
public array $options = []
Подробное описание методов
field() общественный метод
Генерирует поле формы.
Поле формы связано с моделью и атрибутом. Оно содержит метку, поле ввода и сообщение об ошибке и используется для взаимодействия с конечными пользователями, чтобы собрать их входные данные для атрибута.
| public yii\bootstrap\ActiveField field ( $model, $attribute, $options = [] ) | ||
|---|---|---|
| $model | yii\base\Model |
Модель данных. |
| $attribute | string |
Имя атрибута или выражение. См. yii\bootstrap\Html::getAttributeName() для формата выражения атрибута. |
| $options | array |
Дополнительные конфигурации для объекта поля. Это свойства yii\bootstrap\ActiveField или подкласса, в зависимости от значения $fieldClass. |
| return | yii\bootstrap\ActiveField |
Созданный объект ActiveField |
init() общественный метод
Инициализирует виджет.
Это отображает открывающий тег формы.
| public void init ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-activeform.html