Class yii\base\Action

All Classes | Properties | Methods

Inheritance	yii\base\Action » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Subclasses	yii\authclient\AuthAction, yii\base\InlineAction, yii\captcha\CaptchaAction, yii\debug\actions\db\ExplainAction, yii\elasticsearch\DebugAction, yii\gii\console\GenerateAction, yii\httpclient\debug\RequestExecuteAction, yii\mongodb\debug\ExplainAction, yii\rest\Action, yii\rest\CreateAction, yii\rest\DeleteAction, yii\rest\IndexAction, yii\rest\OptionsAction, yii\rest\UpdateAction, yii\rest\ViewAction, yii\web\ErrorAction, yii\web\ViewAction
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/base/Action.php

Action is the base class for all controller action classes.

Action provides a way to reuse action method code. An action method in an Action class can be used in multiple controllers or in different projects.

Derived classes must implement a method named run(). This method will be invoked by the controller when the action is requested. The run() method can have parameters which will be filled up with user input values automatically according to their names. For example, if the run() method is declared as follows:

public function run($id, $type = 'book') { ... }

And the parameters provided for the action are: ['id' => 1]. Then the run() method will be invoked as run(1) automatically.

For more details and usage information on Action, see the guide article on actions.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$controller	yii\base\Controller\|yii\web\Controller\|yii\console\Controller	The controller that owns this action	yii\base\Action
$id	string	ID of the action	yii\base\Action
$uniqueId	string	The unique ID of this action among the whole application.	yii\base\Action

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Action
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getUniqueId()	Returns the unique ID of this action among the whole application.	yii\base\Action
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\base\BaseObject
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
runWithParams()	Runs this action with the specified parameters.	yii\base\Action
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
afterRun()	This method is called right after `run()` is executed.	yii\base\Action
beforeRun()	This method is called right before `run()` is executed.	yii\base\Action

Property Details

$controller public property

The controller that owns this action

public yii\base\Controller|yii\web\Controller|yii\console\Controller $controller = null

$id public property

ID of the action

public string $id = null

$uniqueId public read-only property

The unique ID of this action among the whole application.

public string getUniqueId ( )

Method Details

__construct() public method

Constructor.

public void __construct ( $id, $controller, $config = [] )
$id	string	The ID of this action
$controller	yii\base\Controller	The controller that owns this action
$config	array	Name-value pairs that will be used to initialize the object properties

afterRun() protected method

This method is called right after run() is executed.

You may override this method to do post-processing work for the action run.

protected void afterRun ( )

beforeRun() protected method

This method is called right before run() is executed.

You may override this method to do preparation work for the action run. If the method returns false, it will cancel the action.

protected boolean beforeRun ( )
return	boolean	Whether to run the action.

getUniqueId() public method

Returns the unique ID of this action among the whole application.

public string getUniqueId ( )
return	string	The unique ID of this action among the whole application.

runWithParams() public method

Runs this action with the specified parameters.

This method is mainly invoked by the controller.

public mixed runWithParams ( $params )
$params	array	The parameters to be bound to the action's run() method.
return	mixed	The result of the action
throws	yii\base\InvalidConfigException	if the action class does not have a run() method