Home » Documentation » Class Reference » CAction

CAction

Package	system.web.actions
Inheritance	abstract class CAction » CComponent
Implements	IAction
Subclasses	CCaptchaAction, CInlineAction, CViewAction, CWebServiceAction
Since	1.0
Version	$Id: CAction.php 1678 2010-01-07 21:02:00Z qiang.xue $

CAction is the base class for all controller action classes.

CAction provides a way to divide a complex controller into smaller actions in separate class files.

Derived classes must implement run() which is invoked by controller when the action is requested.

An action instance can access its controller via controller property.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
controller	CController	the controller who owns this action.	CAction
id	string	id of this action	CAction

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CAction
__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
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
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
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
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getController()		CAction
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()		CAction
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
raiseEvent()	Raises an event.	CComponent
run()	Runs the action.	IAction

Property Details

controller property read-only

public CController getController()

the controller who owns this action.

id property read-only

public string getId()

id of this action

Method Details

__construct() method

public void __construct(CController $controller, string $id)
$controller	CController	the controller who owns this action.
$id	string	id of the action.

Constructor.

getController() method

public CController getController()
{return}	CController	the controller who owns this action.

getId() method

public string getId()
{return}	string	id of this action