CCodeForm
| Package | system.gii |
|---|---|
| Inheritance | class CCodeForm » CActiveForm » CWidget » CBaseController » CComponent |
| Since | 1.1.2 |
| Version | $Id: CCodeForm.php 2082 2010-05-01 20:08:11Z qiang.xue $ |
CCodeForm represents the form for collecting code generation parameters.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| action | mixed | the form action URL (see normalizeUrl for details about this parameter. | CActiveForm |
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| clientOptions | array | the options to be passed to the javascript validation plugin. | CActiveForm |
| controller | CController | the controller that this widget belongs to. | CWidget |
| enableAjaxValidation | boolean | whether to enable data validation via AJAX. | CActiveForm |
| errorMessageCssClass | string | the CSS class name for error messages. | CActiveForm |
| htmlOptions | array | additional HTML attributes that should be rendered for the form tag. | CActiveForm |
| id | string | id of the widget. | CWidget |
| method | string | the form submission method. | CActiveForm |
| model | CCodeModel | the code model associated with the form | CCodeForm |
| owner | CBaseController | owner/creator of this widget. | CWidget |
| skin | mixed | the name of the skin to be used by this widget. | CWidget |
| stateful | boolean | whether to generate a stateful form (See CHtml::statefulForm). | CActiveForm |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CWidget |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| actions() | Returns a list of actions that are used by this widget. | CWidget |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| beginCache() | Begins fragment caching. | CBaseController |
| beginClip() | Begins recording a clip. | CBaseController |
| beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController |
| beginWidget() | Creates a widget and executes it. | CBaseController |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| checkBox() | Renders a checkbox for a model attribute. | CActiveForm |
| checkBoxList() | Renders a checkbox list for a model attribute. | CActiveForm |
| createWidget() | Creates a widget and initializes it. | CBaseController |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| dropDownList() | Renders a dropdown list for a model attribute. | CActiveForm |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| endCache() | Ends fragment caching. | CBaseController |
| endClip() | Ends recording a clip. | CBaseController |
| endContent() | Ends the rendering of content. | CBaseController |
| endWidget() | Ends the execution of the named widget. | CBaseController |
| error() | Displays the first validation error for a model attribute. | CActiveForm |
| errorSummary() | Displays a summary of validation errors for one or several models. | CActiveForm |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| fileField() | Renders a file field for a model attribute. | CActiveForm |
| getController() | CWidget | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | CWidget | |
| getOwner() | CWidget | |
| getViewFile() | Looks for the view script file according to the view name. | CWidget |
| getViewPath() | Returns the directory containing the view files for this widget. | CWidget |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes the widget. | CCodeForm |
| label() | Renders an HTML label for a model attribute. | CActiveForm |
| labelEx() | Renders an HTML label for a model attribute. | CActiveForm |
| listBox() | Renders a list box for a model attribute. | CActiveForm |
| passwordField() | Renders a password field for a model attribute. | CActiveForm |
| radioButton() | Renders a radio button for a model attribute. | CActiveForm |
| radioButtonList() | Renders a radio button list for a model attribute. | CActiveForm |
| raiseEvent() | Raises an event. | CComponent |
| render() | Renders a view. | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | Runs the widget. | CCodeForm |
| setId() | CWidget | |
| textArea() | Renders a text area for a model attribute. | CActiveForm |
| textField() | Renders a text field for a model attribute. | CActiveForm |
| validate() | Validates one or several models and returns the results in JSON format. | CActiveForm |
| widget() | Creates a widget and executes it. | CBaseController |
Property Details
model
property
public CCodeModel $model;
the code model associated with the form
Method Details
init()
method
|
public void init()
|
Initializes the widget. This renders the form open tag.
run()
method
|
public void run()
|
Runs the widget.