CallableAction

Type
Class
Namespace
craft\console
Inherits
craft\console\CallableAction » yii\base\Action (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.2.0

Class CallableAction

View source (opens new window)

# Public Properties

Property Description
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
callable callable (opens new window) – The action callable
controller (opens new window) yii\base\Controller (opens new window), yii\web\Controller (opens new window), yii\console\Controller (opens new window) – The controller that owns this action
id (opens new window) string (opens new window) – ID of the action
uniqueId (opens new window) string (opens new window) – The unique ID of this action among the whole application.

# callable

Type
callable (opens new window)
Default value
null

The action callable

View source (opens new window)

# Public Methods

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

# runWithParams()

Runs this action with the specified parameters.

This method is mainly invoked by the controller.

View source (opens new window)

Arguments

Returns

mixed – The result of the action

# Protected Methods

Method Description
afterRun() (opens new window) This method is called right after run() is executed.
beforeRun() (opens new window) This method is called right before run() is executed.