ActionEvent.php 1.02 KB
Newer Older
1 2 3 4 5
<?php
/**
 * ActionEvent class file.
 *
 * @link http://www.yiiframework.com/
Qiang Xue committed
6
 * @copyright Copyright &copy; 2008 Yii Software LLC
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
 * ActionEvent represents the event parameter used for an action event.
 *
 * By setting the [[isValid]] property, one may control whether to continue the life cycle of
 * the action currently being executed.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActionEvent extends Event
{
	/**
	 * @var Action the action currently being executed
	 */
	public $action;
	/**
	 * @var boolean whether the action is in valid state and its life cycle should proceed.
	 */
	public $isValid = true;

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