ActionEvent

API reference › yii › base › ActionEvent

class	`yii\base\ActionEvent`
Extends	`Event` » `BaseObject`
Implements	`Configurable`
Since	2.0
Source	`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.

Properties

Property	Type	Description	Defined by
`$action`	`yii\base\T`	The action currently being executed Default: `null`.	`ActionEvent`
`$data`	`mixed`	The data that is passed to `Component::on()` when attaching an event handler. Default: `null`.	`Event`
`$handled`	`bool`	Whether the event is handled. Default: `false`.	`Event`
`$isValid`	`bool`	Whether to continue running the action. Default: `true`.	`ActionEvent`
`$name`	`string`	The event name. Default: `null`.	`Event`
`$result`	`mixed`	The action result. Default: `null`.	`ActionEvent`
`$sender`	`object\|null`	The sender of this event. Default: `null`.	`Event`

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

public bool $isValid = true

Whether to continue running the action.

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

public mixed $result = null

The action result.

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

public function __construct(yii\base\T $action, array<string, mixed> $config = [])

Constructor.

Parameters

Parameter	Type	Description
`$action`	`yii\base\T`	The action associated with this action event.
`$config`	`array<string, mixed>`	Name-value pairs that will be used to initialize the object properties