Class CActiveForm

the form action URL (see CHtml::normalizeUrl() for details about this parameter). If not set, the current page URL is used.

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

whether to generate a stateful form (See CHtml::statefulForm()). Defaults to false.

the CSS class name for error messages. Since 1.1.14 this defaults to 'errorMessage' defined in CHtml::$errorMessageCss. Individual CActiveForm::error() call may override this value by specifying the 'class' HTML option.

additional HTML attributes that should be rendered for the form tag.

• ajaxVar: string, the name of the parameter indicating the request is an AJAX request. When the AJAX validation is triggered, a parameter named as this property will be sent together with the other form data to the server. The parameter value is the form ID. The server side can then detect who triggers the AJAX validation and react accordingly. Defaults to 'ajax'.
• validationUrl: string, the URL that performs the AJAX validations. If not set, it will take the value of CActiveForm::$action.
• validationDelay: integer, the number of milliseconds that an AJAX validation should be delayed after an input is changed. A value 0 means the validation will be triggered immediately when an input is changed. A value greater than 0 means changing several inputs may only trigger a single validation if they happen fast enough, which may help reduce the server load. Defaults to 200 (0.2 second).
• validateOnSubmit: boolean, whether to perform AJAX validation when the form is being submitted. If there are any validation errors, the form submission will be stopped. Defaults to false.
• validateOnChange: boolean, whether to trigger an AJAX validation each time when an input's value is changed. You may want to turn this off if it causes too much performance impact, because each AJAX validation request will submit the data of the whole form. Defaults to true.
• validateOnType: boolean, whether to trigger an AJAX validation each time when the user presses a key. When setting this property to be true, you should tune up the 'validationDelay' option to avoid triggering too many AJAX validations. Defaults to false.
• hideErrorMessage: boolean, whether to hide the error message even if there is an error. Defaults to false, which means the error message will show up whenever the input has an error.
• inputContainer: string, the jQuery selector for the HTML element containing the input field. During the validation process, CActiveForm will set different CSS class for the container element to indicate the state change. If not set, it means the closest 'div' element that contains the input field.
• errorCssClass: string, the CSS class to be assigned to the container whose associated input has AJAX validation error. Defaults to 'error'.
• successCssClass: string, the CSS class to be assigned to the container whose associated input passes AJAX validation without any error. Defaults to 'success'.
• validatingCssClass: string, the CSS class to be assigned to the container whose associated input is currently being validated via AJAX. Defaults to 'validating'.
• errorMessageCssClass: string, the CSS class assigned to the error messages returned by AJAX validations. Defaults to 'errorMessage'.
• beforeValidate: function, the function that will be invoked before performing ajax-based validation triggered by form submission action (available only when validateOnSubmit is set true). The expected function signature should be beforeValidate(form) {...}, where 'form' is the jquery representation of the form object. If the return value of this function is NOT true, the validation will be cancelled.Note that because this option refers to a js function, you should wrap the value with CJavaScriptExpression to prevent it from being encoded as a string. This option has been available since version 1.1.3.
• afterValidate: function, the function that will be invoked after performing ajax-based validation triggered by form submission action (available only when validateOnSubmit is set true). The expected function signature should be afterValidate(form, data, hasError) {...}, where 'form' is the jquery representation of the form object; 'data' is the JSON response from the server-side validation; 'hasError' is a boolean value indicating whether there is any validation error. If the return value of this function is NOT true, the normal form submission will be cancelled.Note that because this option refers to a js function, you should wrap the value with CJavaScriptExpression to prevent it from being encoded as a string. This option has been available since version 1.1.3.
• beforeValidateAttribute: function, the function that will be invoked before performing ajax-based validation triggered by a single attribute input change. The expected function signature should be beforeValidateAttribute(form, attribute) {...}, where 'form' is the jquery representation of the form object and 'attribute' refers to the js options for the triggering attribute (see CActiveForm::error()). If the return value of this function is NOT true, the validation will be cancelled.Note that because this option refers to a js function, you should wrap the value with CJavaScriptExpression to prevent it from being encoded as a string. This option has been available since version 1.1.3.
• afterValidateAttribute: function, the function that will be invoked after performing ajax-based validation triggered by a single attribute input change. The expected function signature should be afterValidateAttribute(form, attribute, data, hasError) {...}, where 'form' is the jquery representation of the form object; 'attribute' refers to the js options for the triggering attribute (see CActiveForm::error()); 'data' is the JSON response from the server-side validation; 'hasError' is a boolean value indicating whether there is any validation error.Note that because this option refers to a js function, you should wrap the value with CJavaScriptExpression to prevent it from being encoded as a string. This option has been available since version 1.1.3.

Some of the above options may be overridden in individual calls of CActiveForm::error(). They include: validationDelay, validateOnChange, validateOnType, hideErrorMessage, inputContainer, errorCssClass, successCssClass, validatingCssClass, beforeValidateAttribute, afterValidateAttribute.

whether to enable data validation via AJAX. Defaults to false. When this property is set true, you should respond to the AJAX validation request on the server side as shown below:

public function actionCreate()
{
    $model=new User;
    if(isset($_POST['ajax']) && $_POST['ajax']==='user-form')
    {
        echo CActiveForm::validate($model);
        Yii::app()->end();
    }
    ......
}

whether to enable client-side data validation. Defaults to false.

When this property is set true, client-side validation will be performed by validators that support it (see CValidator::$enableClientValidation and CValidator::clientValidateAttribute()).

Since

See

form element to get initial input focus on page load.

Defaults to null meaning no input field has a focus. If set as array, first element should be model and second element should be the attribute. If set as string any jQuery selector can be used

• 'focus'=>array($model,'username') - $model->username input filed
• 'focus'=>'#'.CHtml::activeId($model,'username') - $model->username input field
• 'focus'=>'#LoginForm_username' - input field with ID LoginForm_username
• 'focus'=>'input[type="text"]:first' - first input element of type text
• 'focus'=>'input:visible:enabled:first' - first visible and enabled input element
• 'focus'=>'input:text[value=""]:first' - first empty input

Since

the javascript options for model attributes (input ID => options)

Since

See

the ID of the container element for error summary

Since

See