0 follower

Class yii\base\InlineAction

All Classes | Properties | Methods

Inheritance	yii\base\InlineAction » yii\base\Action » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/base/InlineAction.php

InlineAction represents an action that is defined as a controller method.

The name of the controller method is available via $actionMethod which is set by the $controller who creates this action.

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

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$actionMethod	string	The controller method that this inline action is associated with	yii\base\InlineAction
$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()		yii\base\InlineAction
__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\InlineAction
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

$actionMethod public property

The controller method that this inline action is associated with

public string $actionMethod = null

Method Details

__construct() public method

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

runWithParams() public method

Runs this action with the specified parameters.

This method is mainly invoked by the controller.

public mixed runWithParams ( $params )
$params	array	Action parameters
return	mixed	The result of the action