CCodeModel
| Package | system.gii |
|---|---|
| Inheritance | abstract class CCodeModel » CFormModel » CModel » CComponent |
| Implements | IteratorAggregate, Traversable, ArrayAccess |
| Since | 1.1.2 |
| Version | $Id: CCodeModel.php 2023 2010-04-07 00:41:20Z qiang.xue $ |
CCodeModel is the base class for model classes that are used to generate code.
Each code generator should have at least one code model class that extends from this class. The purpose of a code model is to represent user-supplied parameters and use them to generate customized code.
Derived classes should implement the prepare method whose main task is to fill up the files property based on the user parameters.
The files property should be filled with a set of CCodeFile instances, each representing a single code file to be generated.
CCodeModel implements the feature of "sticky attributes". A sticky attribute is an attribute that can remember its last valid value, even if the user closes his browser window and reopen it. To declare an attribute is sticky, simply list it in a validation rule with the validator name being "sticky".
Each code generator should have at least one code model class that extends from this class. The purpose of a code model is to represent user-supplied parameters and use them to generate customized code.
Derived classes should implement the prepare method whose main task is to fill up the files property based on the user parameters.
The files property should be filled with a set of CCodeFile instances, each representing a single code file to be generated.
CCodeModel implements the feature of "sticky attributes". A sticky attribute is an attribute that can remember its last valid value, even if the user closes his browser window and reopen it. To declare an attribute is sticky, simply list it in a validation rule with the validator name being "sticky".
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| answers | array | user confirmations on whether to overwrite existing code files with the newly generated ones. | CCodeModel |
| attributes | array | Returns all attribute values. | CModel |
| errors | array | Returns the errors for all attribute or a single attribute. | CModel |
| files | array | a list of CCodeFile objects that represent the code files to be generated. | CCodeModel |
| iterator | CMapIterator | Returns an iterator for traversing the attributes in the model. | CModel |
| safeAttributeNames | array | Returns the attribute names that are safe to be massively assigned. | CModel |
| scenario | string | Returns the scenario that this model is used in. | CModel |
| status | integer | the status of this model. | CCodeModel |
| stickyFile | string | the file path that stores the sticky attribute values. | CCodeModel |
| template | string | the name of the code template that the user has selected. | CCodeModel |
| templatePath | string | the directory that contains the template files. | CCodeModel |
| templates | array | Returns a list of available code templates (name=>directory). | CCodeModel |
| validatorList | CList | Returns all the validators declared in the model. | CModel |
| validators | array | Returns the validators applicable to the current scenario. | CModel |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CFormModel |
| __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 |
| addError() | Adds a new error to the specified attribute. | CModel |
| addErrors() | Adds a list of errors. | CModel |
| 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 |
| attributeLabels() | Declares the model attribute labels. | CCodeModel |
| attributeNames() | Returns the list of attribute names. | CFormModel |
| behaviors() | Returns a list of behaviors that this model should behave as. | CModel |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| class2id() | Converts a class name into a HTML ID. | CCodeModel |
| class2name() | Converts a class name into space-separated words. | CCodeModel |
| clearErrors() | Removes errors for all attributes or a single attribute. | CModel |
| confirmed() | CCodeModel | |
| createValidators() | Creates validator objects based on the specification in rules. | CModel |
| 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 |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| errorMessage() | Returns the message to be displayed when some error occurred during code file saving. | CCodeModel |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| generateAttributeLabel() | Generates a user friendly attribute label. | CModel |
| getAttributeLabel() | Returns the text label for the specified attribute. | CModel |
| getAttributes() | Returns all attribute values. | CModel |
| getError() | Returns the first error of the specified attribute. | CModel |
| getErrors() | Returns the errors for all attribute or a single attribute. | CModel |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIterator() | Returns an iterator for traversing the attributes in the model. | CModel |
| getSafeAttributeNames() | Returns the attribute names that are safe to be massively assigned. | CModel |
| getScenario() | Returns the scenario that this model is used in. | CModel |
| getStickyFile() | CCodeModel | |
| getTemplatePath() | CCodeModel | |
| getTemplates() | Returns a list of available code templates (name=>directory). | CCodeModel |
| getValidatorList() | Returns all the validators declared in the model. | CModel |
| getValidators() | Returns the validators applicable to the current scenario. | CModel |
| hasErrors() | Returns a value indicating whether there is any validation error. | CModel |
| 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 this model. | CFormModel |
| isAttributeRequired() | Returns a value indicating whether the attribute is required. | CModel |
| isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | CModel |
| loadStickyAttributes() | Loads sticky attributes from a file and populates them into the model. | CCodeModel |
| offsetExists() | Returns whether there is an element at the specified offset. | CModel |
| offsetGet() | Returns the element at the specified offset. | CModel |
| offsetSet() | Sets the element at the specified offset. | CModel |
| offsetUnset() | Unsets the element at the specified offset. | CModel |
| onAfterValidate() | This event is raised after the validation is performed. | CModel |
| onBeforeValidate() | This event is raised before the validation is performed. | CModel |
| onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. | CModel |
| pluralize() | Converts a word to its plural form. | CCodeModel |
| prepare() | Prepares the code files to be generated. | CCodeModel |
| raiseEvent() | Raises an event. | CComponent |
| render() | Generates the code using the specified code template file. | CCodeModel |
| renderResults() | CCodeModel | |
| requiredTemplates() | Returns a list of code templates that are required. | CCodeModel |
| rules() | Declares the model validation rules. | CCodeModel |
| save() | Saves the generated code into files. | CCodeModel |
| saveStickyAttributes() | Saves sticky attributes into a file. | CCodeModel |
| setAttributes() | Sets the attribute values in a massive way. | CModel |
| setScenario() | CModel | |
| sticky() | The "sticky" validator. | CCodeModel |
| successMessage() | Returns the message to be displayed when the newly generated code is saved successfully. | CCodeModel |
| unsetAttributes() | Unsets the attributes. | CModel |
| validate() | Performs the validation. | CModel |
| validateTemplate() | Validates the template selection. | CCodeModel |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| afterValidate() | This method is invoked after validation ends. | CModel |
| beforeValidate() | This method is invoked before validation starts. | CModel |
Events
| Event | Description | Defined By |
|---|---|---|
| onBeforeValidate | This event is raised before the validation is performed. | CModel |
| onAfterValidate | This event is raised after the validation is performed. | CModel |
| onUnsafeAttribute | This method is invoked when an unsafe attribute is being massively assigned. | CModel |
Property Details
answers
property
public array $answers;
user confirmations on whether to overwrite existing code files with the newly generated ones. The value of this property is internally managed by this class and CCodeGenerator.
files
property
public array $files;
a list of CCodeFile objects that represent the code files to be generated. The prepare() method is responsible to populate this property.
status
property
public integer $status;
the status of this model. T The value of this property is internally managed by CCodeGenerator.
stickyFile
property
read-only
public string getStickyFile()
the file path that stores the sticky attribute values.
template
property
public string $template;
the name of the code template that the user has selected. The value of this property is internally managed by this class and CCodeGenerator.
templatePath
property
read-only
public string getTemplatePath()
the directory that contains the template files.
templates
property
read-only
public array getTemplates()
Returns a list of available code templates (name=>directory). This method simply returns the CCodeGenerator::templates property value.
Method Details
attributeLabels()
method
|
public array attributeLabels()
| ||
| {return} | array | the attribute labels |
Declares the model attribute labels. Child classes must override this method in the following format:
return array_merge(parent::attributeLabels(), array(
...labels for the child class attributes...
));
class2id()
method
|
public string class2id(string $name)
| ||
| $name | string | the string to be converted |
| {return} | string | the resulting ID |
Converts a class name into a HTML ID. For example, 'PostTag' will be converted as 'post-tag'.
class2name()
method
|
public string class2name(string $name, boolean $ucwords=true)
| ||
| $name | string | the string to be converted |
| $ucwords | boolean | whether to capitalize the first letter in each word |
| {return} | string | the resulting words |
Converts a class name into space-separated words. For example, 'PostTag' will be converted as 'Post Tag'.
confirmed()
method
|
public void confirmed(CCodeFile $file)
| ||
| $file | CCodeFile | whether the code file should be saved |
errorMessage()
method
|
public string errorMessage()
| ||
| {return} | string | the message to be displayed when some error occurred during code file saving. |
Returns the message to be displayed when some error occurred during code file saving. Child classes should override this method if the message needs to be customized.
getStickyFile()
method
|
public string getStickyFile()
| ||
| {return} | string | the file path that stores the sticky attribute values. |
getTemplatePath()
method
|
public string getTemplatePath()
| ||
| {return} | string | the directory that contains the template files. |
getTemplates()
method
|
public array getTemplates()
| ||
| {return} | array | a list of available code templates (name=>directory). |
Returns a list of available code templates (name=>directory). This method simply returns the CCodeGenerator::templates property value.
loadStickyAttributes()
method
|
public void loadStickyAttributes()
|
Loads sticky attributes from a file and populates them into the model.
pluralize()
method
|
public string pluralize(string $name)
| ||
| $name | string | the word to be pluralized |
| {return} | string | the pluralized word |
Converts a word to its plural form. Note that this is for English only! For example, 'apple' will become 'apples', and 'child' will become 'children'.
prepare()
method
|
abstract public void prepare()
|
Prepares the code files to be generated. This is the main method that child classes should implement. It should contain the logic that populates the files property with a list of code files to be generated.
render()
method
|
public string render(string $templateFile, array $_params_=NULL)
| ||
| $templateFile | string | the code template file path |
| $_params_ | array | a set of parameters to be extracted and made available in the code template |
| {return} | string | the generated code |
Generates the code using the specified code template file. This method is manly used in generate to generate code.
renderResults()
method
|
public string renderResults()
| ||
| {return} | string | the code generation result log. |
requiredTemplates()
method
|
public array requiredTemplates()
| ||
| {return} | array | list of code templates that are required. They should be file paths relative to templatePath. |
Returns a list of code templates that are required. Derived classes usually should override this method.
rules()
method
|
public array rules()
| ||
| {return} | array | validation rules |
Declares the model validation rules. Child classes must override this method in the following format:
return array_merge(parent::rules(), array(
...rules for the child class...
));
save()
method
|
public void save()
|
Saves the generated code into files.
saveStickyAttributes()
method
|
public void saveStickyAttributes()
|
Saves sticky attributes into a file.
sticky()
method
|
public void sticky(string $attribute, array $params)
| ||
| $attribute | string | the attribute to be validated |
| $params | array | the validation parameters |
The "sticky" validator. This validator does not really validate the attributes. It actually saves the attribute value in a file to make it sticky.
successMessage()
method
|
public string successMessage()
| ||
| {return} | string | the message to be displayed when the newly generated code is saved successfully. |
Returns the message to be displayed when the newly generated code is saved successfully. Child classes should override this method if the message needs to be customized.
validateTemplate()
method
|
public void validateTemplate(string $attribute, array $params)
| ||
| $attribute | string | the attribute to be validated |
| $params | array | validation parameters |
Validates the template selection. This method validates whether the user selects an existing template and the template contains all required template files as specified in requiredTemplates.