CInlineAction
| Package | system.web.actions |
|---|---|
| Inheritance | class CInlineAction » CAction » CComponent |
| Implements | IAction |
| Since | 1.0 |
| Source Code | framework/web/actions/CInlineAction.php |
CInlineAction represents an action that is defined as a controller method.
The method name is like 'actionXYZ' where 'XYZ' stands for the action name.
The method name is like 'actionXYZ' where 'XYZ' stands for the action name.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| controller | CController | the controller who owns this action. | CAction |
| id | string | id of this action | CAction |
Public 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() | Returns the controller who owns this action. | CAction |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | Returns id of this action | 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. | CInlineAction |
| runWithParams() | Runs the action with the supplied request parameters. | CInlineAction |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| runWithParamsInternal() | Executes a method of an object with the supplied named parameters. | CAction |
Method Details
run() method
public void run() |
Source Code: framework/web/actions/CInlineAction.php#28 (show)
public function run()
{
$method='action'.$this->getId();
$this->getController()->$method();
}
Runs the action. The action method defined in the controller is invoked. This method is required by CAction.
runWithParams() method (available since v1.1.7)
public boolean runWithParams(array $params) | ||
| $params | array | the request parameters (name=>value) |
| {return} | boolean | whether the request parameters are valid |
Source Code: framework/web/actions/CInlineAction.php#41 (show)
public function runWithParams($params)
{
$methodName='action'.$this->getId();
$controller=$this->getController();
$method=new ReflectionMethod($controller, $methodName);
if($method->getNumberOfParameters()>0)
return $this->runWithParamsInternal($controller, $method, $params);
$controller->$methodName();
return true;
}
Runs the action with the supplied request parameters. This method is internally called by CController::runAction().
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CInlineAction