Versions
Look up a class, method, property or event

CCodeForm

Package system.gii
Inheritance class CCodeForm » CActiveForm » CWidget » CBaseController » CComponent
Since 1.1.2
Source Code framework/gii/CCodeForm.php
CCodeForm represents the form for collecting code generation parameters.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
action mixed the form action URL (see CHtml::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 Returns the controller that this widget belongs to. CWidget
enableAjaxValidation boolean whether to enable data validation via AJAX. CActiveForm
enableClientValidation boolean whether to enable client-side data validation. CActiveForm
errorMessageCssClass string the CSS class name for error messages. CActiveForm
focus mixed form element to get initial input focus on page load. CActiveForm
htmlOptions array additional HTML attributes that should be rendered for the form tag. CActiveForm
id string Returns the ID of the widget or generates a new one if requested. CWidget
method string the form submission method. CActiveForm
model CCodeModel the code model associated with the form CCodeForm
owner CBaseController Returns the 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

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
attributes array the javascript options for model attributes (input ID => options) CActiveForm
summaryID string the ID of the container element for error summary CActiveForm

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
colorField() Renders a color picker field for a model attribute. CActiveForm
createWidget() Creates a widget and initializes it. CBaseController
dateField() Renders a date field for a model attribute. CActiveForm
dateTimeField() Renders a datetime field for a model attribute. CActiveForm
dateTimeLocalField() Renders a local datetime field for a model attribute. CActiveForm
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
emailField() Renders an email field 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() Returns the controller that this widget belongs to. CWidget
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getId() Returns the ID of the widget or generates a new one if requested. CWidget
getOwner() Returns the owner/creator of this widget. 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
hiddenField() Renders a hidden field for a model attribute. CActiveForm
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
numberField() Renders a number field 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
rangeField() Generates a range field for a model attribute. CActiveForm
render() Renders a view. CWidget
renderFile() Renders a view file. CBaseController
renderInternal() Renders a view file. CBaseController
run() Runs the widget. CCodeForm
searchField() Renders a search field for a model attribute. CActiveForm
setId() Sets the ID of the widget. CWidget
telField() Renders a tel field for a model attribute. CActiveForm
textArea() Renders a text area for a model attribute. CActiveForm
textField() Renders a text field for a model attribute. CActiveForm
timeField() Renders a time field for a model attribute. CActiveForm
urlField() Renders a url field for a model attribute. CActiveForm
validate() Validates one or several models and returns the results in JSON format. CActiveForm
validateTabular() Validates an array of model instances and returns the results in JSON format. CActiveForm
weekField() Renders a week field for a model attribute. 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()
Source Code: framework/gii/CCodeForm.php#29 (show)
public function init()
{
    echo <<<EOD
<div class="form gii">
<p class="note">
    Fields with <span class="required">*</span> are required.
    Click on the <span class="sticky">highlighted fields</span> to edit them.
</p>
EOD;
    
parent::init();
}

Initializes the widget. This renders the form open tag.

run() method
public void run()
Source Code: framework/gii/CCodeForm.php#44 (show)
public function run()
{
    
$templates=array();
    foreach(
$this->model->getTemplates() as $i=>$template)
        
$templates[$i]=basename($template).' ('.$template.')';

    
$this->renderFile(Yii::getPathOfAlias('gii.views.common.generator').'.php',array(
        
'model'=>$this->model,
        
'templates'=>$templates,
    ));

    
parent::run();

    echo 
"</div>";
}

Runs the widget.

Be the first person to leave a comment

Please to leave your comment.