CForm

'elements'=>array(
    'username'=>array('type'=>'text', 'maxlength'=>80),
    'password'=>array('type'=>'password', 'maxlength'=>80),
)

Property Details

the form action URL (see CHtml::normalizeUrl for details about this parameter.) Defaults to an empty string, meaning the current request URL. This property is ignored when this form is a sub-form.

the configuration used to create the active form widget. The widget will be used to render the form tag and the error messages. The 'class' option is required, which specifies the class of the widget. The rest of the options will be passed to CBaseController::beginWidget() call. Defaults to array('class'=>'CActiveForm').

the active form widget associated with this form. This method will return the active form widget as specified by activeForm.

the name of the class for representing a form button element. Defaults to 'CFormButtonElement'.

Returns the button elements of this form. Note that the returned result is a CFormElementCollection object, which means you can use it like an array. For more details, see CMap.

the description of this form.

Returns the input elements of this form. This includes text strings, input elements and sub-forms. Note that the returned result is a CFormElementCollection object, which means you can use it like an array. For more details, see CMap.

the name of the class for representing a form input element. Defaults to 'CFormInputElement'.

the submission method of this form. Defaults to 'post'. This property is ignored when this form is a sub-form.

Returns the model that this form is associated with.

Returns all models that are associated with this form or its sub-forms.

the owner of this form. This refers to either a controller or a widget by which the form is created and rendered.

the top-level form object

whether to show error summary. Defaults to false.

the title for this form. By default, if this is set, a fieldset may be rendered around the form body using the title as its legend. Defaults to null.

Returns a unique ID that identifies this form in the current page.

Method Details

Constructor. If you override this method, make sure you do not modify the method signature, and also make sure you call the parent implementation.

This method is called after an element is added to the element collection.

Returns a value indicating whether the specified button is clicked.

Evaluates the visibility of this form. This method will check the visibility of the elements. If any one of them is visible, the form is considered as visible. Otherwise, it is invisible.

Returns the button elements of this form. Note that the returned result is a CFormElementCollection object, which means you can use it like an array. For more details, see CMap.

Returns the input elements of this form. This includes text strings, input elements and sub-forms. Note that the returned result is a CFormElementCollection object, which means you can use it like an array. For more details, see CMap.

Returns the model that this form is associated with.

Returns all models that are associated with this form or its sub-forms.

Returns a unique ID that identifies this form in the current page.

Initializes this form. This method is invoked at the end of the constructor. You may override this method to provide customized initialization (such as configuring the form object).

Loads the submitted data into the associated model(s) to the form. This method will go through all models associated with this form and its sub-forms and massively assign the submitted data to the models.

Returns whether there is an element at the specified offset. This method is required by the interface ArrayAccess.

Returns the element at the specified offset. This method is required by the interface ArrayAccess.

Sets the element at the specified offset. This method is required by the interface ArrayAccess.

Unsets the element at the specified offset. This method is required by the interface ArrayAccess.

This method is called after an element is removed from the element collection.

Renders the form. The default implementation simply calls renderBegin, renderBody and renderEnd.

Renders the open tag of the form. The default implementation will render the open form tag.

Renders the body content of this form. This method mainly renders elements and buttons. If title or description is specified, they will be rendered as well. And if the associated model contains error, the error summary may also be displayed. The form tag will not be rendered. Please call renderBegin and renderEnd to render the open and close tags of the form. You may override this method to customize the rendering of the form.

Renders the buttons in this form.

Renders a single element which could be an input element, a sub-form, a string, or a button.

Renders the elements in this form.

Renders the close tag of the form.

Configures the buttons of this form. The configuration must be an array of button configuration array indexed by button name. Each button configuration array consists of name-value pairs that are used to initialize a CFormButtonElement object.

Configures the input elements of this form. The configuration must be an array of input configuration array indexed by input name. Each input configuration array consists of name-value pairs that are used to initialize a CFormStringElement object (when 'type' is 'string'), a CFormElement object (when 'type' is a string ending with 'Form'), or a CFormInputElement object in all other cases.

Returns a value indicating whether this form is submitted.

Validates the models associated with this form. All models, including those associated with sub-forms, will perform the validation. You may use CModel::getErrors() to retrieve the validation error messages.