Класс yii\widgets\ActiveForm

ActiveForm — это виджет, который создаёт интерактивную HTML-форму для одной или нескольких моделей данных.

Для получения более подробной информации и рекомендаций по использованию ActiveForm, ознакомьтесь со статьёй руководства по формам.

Публичные свойства

Общедоступные методы

Защищенные методы

События

Подробности о свойствах

$action общедоступное свойство

URL действия формы. Этот параметр будет обработан yii\helpers\Url::to().

См. также $method для указания HTTP-метода для этой формы.

public array|string $action = ''

$ajaxDataType общественное свойство

Тип данных, ожидаемых от сервера.

public string $ajaxDataType = 'json'

$ajaxParam общественное свойство

Имя параметра GET, указывающего, что запрос валидации — это AJAX-запрос.

public string $ajaxParam = 'ajax'

$attributes общественное свойство

Параметры клиентской валидации для отдельных атрибутов. Каждый элемент массива представляет параметры валидации для конкретного атрибута.

public array $attributes = []

$enableAjaxValidation общественное свойство

Включить AJAX-валидацию данных. Если yii\widgets\ActiveField::$enableAjaxValidation задан, его значение будет иметь приоритет для этого поля ввода.

public boolean $enableAjaxValidation = false

$enableClientScript общественное свойство

Включить подключение yii.activeForm JavaScript-плагина. Это свойство должно быть установлено true , если вы хотите поддерживать клиентскую валидацию и/или AJAX-валидацию или если вы хотите воспользоваться yii.activeForm плагином. Когда это свойство false, форма не будет генерировать JavaScript.

См. также registerClientScript().

public boolean $enableClientScript = true

$enableClientValidation общественное свойство

Включить валидацию данных на стороне клиента. Если yii\widgets\ActiveField::$enableClientValidation задан, его значение будет иметь приоритет для этого поля ввода.

public boolean $enableClientValidation = true

$encodeErrorSummary общественное свойство

Выполнять кодирование для сводки ошибок.

public boolean $encodeErrorSummary = true

$errorCssClass общественное свойство

CSS-класс, который добавляется к контейнеру поля, когда связанный атрибут имеет ошибку валидации.

public string $errorCssClass = 'has-error'

$errorSummaryCssClass общественное свойство

Основной CSS-класс для контейнера сводки ошибок.

См. также errorSummary().

public string $errorSummaryCssClass = 'error-summary'

$fieldClass общественное свойство

Имя класса поля по умолчанию при вызове field() для создания нового поля.

См. также $fieldConfig.

public string $fieldClass = 'yii\widgets\ActiveField'

$fieldConfig общественное свойство

Настройка по умолчанию, используемая field() при создании нового объекта поля. Это может быть массив настроек или анонимная функция, возвращающая массив настроек. Если это последняя, её сигнатура должна быть следующей:

function ($model, $attribute)

Значение этого свойства будет рекурсивно объединено с параметром $options , переданным field().

См. также $fieldClass.

public array|Closure $fieldConfig = []

$method общественное свойство

Метод отправки формы. Должно быть либо post , либо get. По умолчанию post.

При установке значения get вы можете увидеть параметры URL, повторяющиеся в каждом запросе. Это потому, что значение по умолчанию $action установлено как текущий URL запроса, и каждое отправление добавляет новые параметры вместо замены существующих. Вы можете явно установить $action , чтобы этого избежать:

$form = ActiveForm::begin([
    'method' => 'get',
    'action' => ['controller/action'],
]);

public string $method = 'post'

$options общественное свойство

Атрибуты HTML (парные имя-значение) для тега формы.

См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.

public array $options = []

$requiredCssClass общественное свойство

CSS-класс, который добавляется к контейнеру поля, когда связанный атрибут является обязательным.

public string $requiredCssClass = 'required'

$scrollToError общественное свойство (доступно начиная с версии 2.0.6)

Прокрутить ли до первой ошибки после валидации.

public boolean $scrollToError = true

$scrollToErrorOffset общественное свойство (доступно начиная с версии 2.0.11)

Смещение в пикселях, которое должно быть добавлено при прокрутке к первой ошибке.

public integer $scrollToErrorOffset = 0

$successCssClass общественное свойство

CSS-класс, который добавляется к контейнеру поля, когда связанный атрибут успешно прошел валидацию.

public string $successCssClass = 'has-success'

$validateOnBlur общественное свойство

Выполнять ли валидацию, когда поле ввода теряет фокус. Если yii\widgets\ActiveField::$validateOnBlur задан, его значение будет иметь приоритет для этого поля ввода.

public boolean $validateOnBlur = true

$validateOnChange общественное свойство

Выполнять ли валидацию, когда значение поля ввода меняется. Если yii\widgets\ActiveField::$validateOnChange задан, его значение будет иметь приоритет для этого поля ввода.

public boolean $validateOnChange = true

$validateOnSubmit общественное свойство

Выполнять ли валидацию при отправке формы.

public boolean $validateOnSubmit = true

$validateOnType общественное свойство

Выполнять ли валидацию, пока пользователь вводит в поле ввода. Если yii\widgets\ActiveField::$validateOnType задан, его значение будет иметь приоритет для этого поля ввода.

См. также $validationDelay.

public boolean $validateOnType = false

$validatingCssClass общественное свойство

CSS-класс, который добавляется к контейнеру поля, когда связанный атрибут проходит валидацию.

public string $validatingCssClass = 'validating'

$validationDelay общественное свойство

Количество миллисекунд, на которое должна быть отложена валидация, когда пользователь вводит в поле, и $validateOnType установлен true. Если yii\widgets\ActiveField::$validationDelay задан, его значение будет иметь приоритет для этого поля ввода.

public integer $validationDelay = 500

$validationUrl общественное свойство

URL для выполнения AJAX-валидации. Это свойство будет обработано yii\helpers\Url::to(). Обратитесь к yii\helpers\Url::to() для получения дополнительной информации о настройке этого свойства. Если это свойство не задано, оно будет принимать значение атрибута действия формы.

public array|string $validationUrl = null

Подробное описание методов

$model = new Post;
$model->load(Yii::$app->request->post());
if (Yii::$app->request->isAjax) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}
// ... respond to non-AJAX request ...

ActiveForm::validate($model1, $model2, ...);

// ... load $models ...
if (Yii::$app->request->isAjax) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validateMultiple($models);
}
// ... respond to non-AJAX request ...