Class CommonControllerBehavior

A behavior for controllers; contains methods common to controllers whether or not they are children of x2base.

All controllers that use this behavior must declare the "modelClass" property.

CComponent

CBehavior implements IBehavior

CommonControllerBehavior

Package: application\components
Located at x2engine/protected/components/CommonControllerBehavior.php

Methods summary
`public`	# `attach( CComponent $owner )` Attaches the behavior object to the component. The default implementation will set the owner property and attach event handlers as declared in `CBehavior::events()`. This method will also set enabled to true. Make sure you've declared handler as public and call the parent implementation if you override this method. Attaches the behavior object to the component. The default implementation will set the owner property and attach event handlers as declared in `CBehavior::events()`. This method will also set enabled to true. Make sure you've declared handler as public and call the parent implementation if you override this method. Parameters `$owner` `CComponent` $owner the component that this behavior is to be attached to. Overrides `CBehavior::attach()`
`public`	# `getModel( integer $id = null )` Returns the data model based on the primary key given. Returns the data model based on the primary key given. If the data model is not found, an HTTP exception will be raised. Parameters `$id` `integer` $id the ID of the model to be loaded. Note, it is assumed that when this value is null, _model is set already; otherwise there's nothing that can be done to correctly resolve the model.
`public`	# `lookUpModel( mixed $id, mixed $modelClass )`
`public string`	# `getRealIp( )` Obtain the IP address of the current web client. Obtain the IP address of the current web client. Returns `string`
`public string`	# `getResolvedModelClass( )` Resolve and return the model class, if specified, or a guess. Resolve and return the model class, if specified, or a guess. Returns `string`
`public type`	# `loadModel( mixed $id )` Kept for backwards compatibility with controllers (including custom ones) that use loadModel. Kept for backwards compatibility with controllers (including custom ones) that use loadModel. Returns `type`
`public`	# `renderGaCode( type $location )` Renders Google Analytics tracking code, if enabled. Renders Google Analytics tracking code, if enabled. Parameters `$location` `type` $location Named location in the app
`public`	# `errorMessage( type $message, mixed $code = 500, mixed $type = "PHP Error" )` For server config or other expected errors which are not bugs but prevent the software from functioning properly. For server config or other expected errors which are not bugs but prevent the software from functioning properly. Parameters `$message` `type` $error `$code` `$type`

Methods inherited from CBehavior
`detach(), events(), getEnabled(), getOwner(), setEnabled()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public boolean`	`$redirectOnNullModel`	`true`	#
`public boolean`	`$throwOnNullModel`	`true`	#

Magic properties summary
`public X2Model`	`$model`	# (read-only); in the context of viewing or updating a record, this contains the active record object corresponding to that record. Its value is set by calling `CommonControllerBehavior::getModel()` with the ID of the desired record. (read-only); in the context of viewing or updating a record, this contains the active record object corresponding to that record. Its value is set by calling `CommonControllerBehavior::getModel()` with the ID of the desired record.
`public string`	`$resolvedModelClass`	# (read-only) The class name of the model to use for model. In some cases (i.e. some older custom modules) the class name will not be specified in the controller, and thus it is useful to guess its corresponding model's name based on its own name. (read-only) The class name of the model to use for model. In some cases (i.e. some older custom modules) the class name will not be specified in the controller, and thus it is useful to guess its corresponding model's name based on its own name.

Magic properties inherited from CBehavior
`$enabled, $owner`

Packages

Classes

Class CommonControllerBehavior

Parameters

Overrides

Parameters

Returns

Returns

Returns

Parameters

Parameters