0 follower

Class yii\base\ActionEvent

All Classes | Properties | Methods

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

ActionEvent represents the event parameter used for an action event.

By setting the $isValid property, one may control whether to continue running the action.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$action	yii\base\Action	The action currently being executed	yii\base\ActionEvent
$data	mixed	The data that is passed to yii\base\Component::on() when attaching an event handler.	yii\base\Event
$handled	boolean	Whether the event is handled.	yii\base\Event
$isValid	boolean	Whether to continue running the action.	yii\base\ActionEvent
$name	string	The event name.	yii\base\Event
$result	mixed	The action result.	yii\base\ActionEvent
$sender	object	The sender of this event.	yii\base\Event

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()	Constructor.	yii\base\ActionEvent
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
hasHandlers()	Returns a value indicating whether there is any handler attached to the specified class-level event.	yii\base\Event
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	yii\base\BaseObject
off()	Detaches an event handler from a class-level event.	yii\base\Event
offAll()	Detaches all registered class-level event handlers.	yii\base\Event
on()	Attaches an event handler to a class-level event.	yii\base\Event
trigger()	Triggers a class-level event.	yii\base\Event

Property Details

$action public property

The action currently being executed

public yii\base\Action $action = null

$isValid public property

Whether to continue running the action. Event handlers of yii\base\Controller::EVENT_BEFORE_ACTION may set this property to decide whether to continue running the current action.

public boolean $isValid = true

$result public property

The action result. Event handlers may modify this property to change the action result.

public mixed $result = null

Method Details

__construct() public method

Constructor.

public void __construct ( $action, $config = [] )
$action	yii\base\Action	The action associated with this action event.
$config	array	Name-value pairs that will be used to initialize the object properties