Class yii\widgets\ActiveForm

ActiveForm is a widget that builds an interactive HTML form for one or multiple data models.

For more details and usage information on ActiveForm, see the guide article on forms.

Public Properties

Public Methods

Protected Methods

Events

Property Details

$action public property

The form action URL. This parameter will be processed by yii\helpers\Url::to().

See also $method for specifying the HTTP method for this form.

public array|string $action = ''

$ajaxDataType public property

The type of data that you're expecting back from the server.

public string $ajaxDataType = 'json'

$ajaxParam public property

The name of the GET parameter indicating the validation request is an AJAX request.

public string $ajaxParam = 'ajax'

$attributes public property

The client validation options for individual attributes. Each element of the array represents the validation options for a particular attribute.

public array $attributes = []

$enableAjaxValidation public property

Whether to enable AJAX-based data validation. If yii\widgets\ActiveField::$enableAjaxValidation is set, its value will take precedence for that input field.

public boolean $enableAjaxValidation = false

$enableClientScript public property

Whether to hook up yii.activeForm JavaScript plugin. This property must be set true if you want to support client validation and/or AJAX validation, or if you want to take advantage of the yii.activeForm plugin. When this is false, the form will not generate any JavaScript.

See also registerClientScript().

public boolean $enableClientScript = true

$enableClientValidation public property

Whether to enable client-side data validation. If yii\widgets\ActiveField::$enableClientValidation is set, its value will take precedence for that input field.

public boolean $enableClientValidation = true

$encodeErrorSummary public property

Whether to perform encoding on the error summary.

public boolean $encodeErrorSummary = true

$errorCssClass public property

The CSS class that is added to a field container when the associated attribute has validation error.

public string $errorCssClass = 'has-error'

$errorSummaryCssClass public property

The default CSS class for the error summary container.

See also errorSummary().

public string $errorSummaryCssClass = 'error-summary'

$fieldClass public property

The default field class name when calling field() to create a new field.

See also $fieldConfig.

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

$fieldConfig public property

The default configuration used by field() when creating a new field object. This can be either a configuration array or an anonymous function returning a configuration array. If the latter, the signature should be as follows:

function ($model, $attribute)

The value of this property will be merged recursively with the $options parameter passed to field().

See also $fieldClass.

public array|Closure $fieldConfig = []

$method public property

The form submission method. This should be either post or get. Defaults to post.

When you set this to get you may see the url parameters repeated on each request. This is because the default value of $action is set to be the current request url and each submit will add new parameters instead of replacing existing ones. You may set $action explicitly to avoid this:

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

public string $method = 'post'

$options public property

The HTML attributes (name-value pairs) for the form tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = []

$requiredCssClass public property

The CSS class that is added to a field container when the associated attribute is required.

public string $requiredCssClass = 'required'

$scrollToError public property (available since version 2.0.6)

Whether to scroll to the first error after validation.

public boolean $scrollToError = true

$scrollToErrorOffset public property (available since version 2.0.11)

Offset in pixels that should be added when scrolling to the first error.

public integer $scrollToErrorOffset = 0

$successCssClass public property

The CSS class that is added to a field container when the associated attribute is successfully validated.

public string $successCssClass = 'has-success'

$validateOnBlur public property

Whether to perform validation when an input field loses focus. If yii\widgets\ActiveField::$validateOnBlur is set, its value will take precedence for that input field.

public boolean $validateOnBlur = true

$validateOnChange public property

Whether to perform validation when the value of an input field is changed. If yii\widgets\ActiveField::$validateOnChange is set, its value will take precedence for that input field.

public boolean $validateOnChange = true

$validateOnSubmit public property

Whether to perform validation when the form is submitted.

public boolean $validateOnSubmit = true

$validateOnType public property

Whether to perform validation while the user is typing in an input field. If yii\widgets\ActiveField::$validateOnType is set, its value will take precedence for that input field.

See also $validationDelay.

public boolean $validateOnType = false

$validatingCssClass public property

The CSS class that is added to a field container when the associated attribute is being validated.

public string $validatingCssClass = 'validating'

$validationDelay public property

Number of milliseconds that the validation should be delayed when the user types in the field and $validateOnType is set true. If yii\widgets\ActiveField::$validationDelay is set, its value will take precedence for that input field.

public integer $validationDelay = 500

$validationUrl public property

The URL for performing AJAX-based validation. This property will be processed by yii\helpers\Url::to(). Please refer to yii\helpers\Url::to() for more details on how to configure this property. If this property is not set, it will take the value of the form's action attribute.

public array|string $validationUrl = null

Method Details

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