ActionEvent.php 1.18 KB
Newer Older
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
5 6 7 8 9 10 11 12
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
 * ActionEvent represents the event parameter used for an action event.
 *
Qiang Xue committed
13
 * By setting the [[isValid]] property, one may control whether to continue running the action.
14 15 16 17 18 19 20 21 22 23
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActionEvent extends Event
{
	/**
	 * @var Action the action currently being executed
	 */
	public $action;
24 25 26 27
	/**
	 * @var mixed the action result. Event handlers may modify this property to change the action result.
	 */
	public $result;
28
	/**
29 30 31
	 * @var boolean 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.
32 33 34 35 36 37
	 */
	public $isValid = true;

	/**
	 * Constructor.
	 * @param Action $action the action associated with this action event.
Qiang Xue committed
38
	 * @param array $config name-value pairs that will be used to initialize the object properties
39
	 */
Alexander Makarov committed
40
	public function __construct($action, $config = [])
41 42
	{
		$this->action = $action;
Qiang Xue committed
43
		parent::__construct($config);
44 45
	}
}