CActiveForm

<?php $form = $this->beginWidget('CActiveForm', array(
    'id'=>'user-form',
    'enableAjaxValidation'=>true,
    'enableClientValidation'=>true,
    'focus'=>array($model,'firstName'),
)); ?>

<?php echo $form->errorSummary($model); ?>

<div class="row">
    <?php echo $form->labelEx($model,'firstName'); ?>
    <?php echo $form->textField($model,'firstName'); ?>
    <?php echo $form->error($model,'firstName'); ?>
</div>
<div class="row">
    <?php echo $form->labelEx($model,'lastName'); ?>
    <?php echo $form->textField($model,'lastName'); ?>
    <?php echo $form->error($model,'lastName'); ?>
</div>

<?php $this->endWidget(); ?>

public function actionCreate()
{
    $model=new User;
    $this->performAjaxValidation($model);
    if(isset($_POST['User']))
    {
        $model->attributes=$_POST['User'];
        if($model->save())
            $this->redirect('index');
    }
    $this->render('create',array('model'=>$model));
}

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

Property Details

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

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

the options to be passed to the javascript validation plugin. The following options are supported:

• 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 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.
• errorCallback: function, the function to be invoked if the ajax request fails.
  
  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 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 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.

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

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

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

Example - set input focus on page load to:

• '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

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

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 ID of the container element for error summary

Method Details

Renders a checkbox for a model attribute. This method is a wrapper of CHtml::activeCheckBox. Please check CHtml::activeCheckBox for detailed information about the parameters for this method.

Renders a checkbox list for a model attribute. This method is a wrapper of CHtml::activeCheckBoxList. Please check CHtml::activeCheckBoxList for detailed information about the parameters for this method.

Renders a color picker field for a model attribute. This method is a wrapper of CHtml::activeColorField. Please check CHtml::activeColorField for detailed information about the parameters for this method.

Renders a date field for a model attribute. This method is a wrapper of CHtml::activeDateField. Please check CHtml::activeDateField for detailed information about the parameters for this method.

Renders a datetime field for a model attribute. This method is a wrapper of CHtml::activeDateTimeField. Please check CHtml::activeDateTimeField for detailed information about the parameters for this method.

Renders a local datetime field for a model attribute. This method is a wrapper of CHtml::activeDateTimeLocalField. Please check CHtml::activeDateTimeLocalField for detailed information about the parameters for this method.

Renders a dropdown list for a model attribute. This method is a wrapper of CHtml::activeDropDownList. Please check CHtml::activeDropDownList for detailed information about the parameters for this method.

Renders an email field for a model attribute. This method is a wrapper of CHtml::activeEmailField. Please check CHtml::activeEmailField for detailed information about the parameters for this method.

<div class="form-element">
   <?php echo $form->labelEx($model,'attribute'); ?>
   <?php echo $form->textField($model,'attribute', array('id'=>'custom-id')); ?>
   <?php echo $form->error($model,'attribute',array('inputID'=>'custom-id')); ?>
</div>

Displays the first validation error for a model attribute. This is similar to CHtml::error except that it registers the model attribute so that if its value is changed by users, an AJAX validation may be triggered.

Displays a summary of validation errors for one or several models. This method is very similar to CHtml::errorSummary except that it also works when AJAX validation is performed.

Renders a file field for a model attribute. This method is a wrapper of CHtml::activeFileField. Please check CHtml::activeFileField for detailed information about the parameters for this method.

Renders a hidden field for a model attribute. This method is a wrapper of CHtml::activeHiddenField. Please check CHtml::activeHiddenField for detailed information about the parameters for this method.

Initializes the widget. This renders the form open tag.

Renders an HTML label for a model attribute. This method is a wrapper of CHtml::activeLabel. Please check CHtml::activeLabel for detailed information about the parameters for this method.

Renders an HTML label for a model attribute. This method is a wrapper of CHtml::activeLabelEx. Please check CHtml::activeLabelEx for detailed information about the parameters for this method.

Renders a list box for a model attribute. This method is a wrapper of CHtml::activeListBox. Please check CHtml::activeListBox for detailed information about the parameters for this method.

Renders a number field for a model attribute. This method is a wrapper of CHtml::activeNumberField. Please check CHtml::activeNumberField for detailed information about the parameters for this method.

Renders a password field for a model attribute. This method is a wrapper of CHtml::activePasswordField. Please check CHtml::activePasswordField for detailed information about the parameters for this method.

Renders a radio button for a model attribute. This method is a wrapper of CHtml::activeRadioButton. Please check CHtml::activeRadioButton for detailed information about the parameters for this method.

Renders a radio button list for a model attribute. This method is a wrapper of CHtml::activeRadioButtonList. Please check CHtml::activeRadioButtonList for detailed information about the parameters for this method.

Generates a range field for a model attribute. This method is a wrapper of CHtml::activeRangeField. Please check CHtml::activeRangeField for detailed information about the parameters for this method.

Runs the widget. This registers the necessary javascript code and renders the form close tag.

Renders a search field for a model attribute. This method is a wrapper of CHtml::activeSearchField. Please check CHtml::activeSearchField for detailed information about the parameters for this method.

Renders a tel field for a model attribute. This method is a wrapper of CHtml::activeTelField. Please check CHtml::activeTelField for detailed information about the parameters for this method.

Renders a text area for a model attribute. This method is a wrapper of CHtml::activeTextArea. Please check CHtml::activeTextArea for detailed information about the parameters for this method.

Renders a text field for a model attribute. This method is a wrapper of CHtml::activeTextField. Please check CHtml::activeTextField for detailed information about the parameters for this method.

Renders a time field for a model attribute. This method is a wrapper of CHtml::activeTimeField. Please check CHtml::activeTimeField for detailed information about the parameters for this method.

Renders a url field for a model attribute. This method is a wrapper of CHtml::activeUrlField. Please check CHtml::activeUrlField for detailed information about the parameters for this method.

Validates one or several models and returns the results in JSON format. This is a helper method that simplifies the way of writing AJAX validation code.

Validates an array of model instances and returns the results in JSON format. This is a helper method that simplifies the way of writing AJAX validation code for tabular input.

Renders a week field for a model attribute. This method is a wrapper of CHtml::activeWeekField. Please check CHtml::activeWeekField for detailed information about the parameters for this method.