|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Event class file.
|
|
|
|
*
|
|
|
|
* @link http://www.yiiframework.com/
|
|
|
|
* @copyright Copyright © 2008-2012 Yii Software LLC
|
|
|
|
* @license http://www.yiiframework.com/license/
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace yii\base;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Event is the base class for all event classes.
|
|
|
|
*
|
|
|
|
* It encapsulates the parameters associated with an event.
|
|
|
|
* The [[sender]] property describes who raises the event.
|
|
|
|
* And the [[handled]] property indicates if the event is handled.
|
|
|
|
* If an event handler sets [[handled]] to be true, the rest of the
|
|
|
|
* uninvoked handlers will no longer be called to handle the event.
|
|
|
|
* Additionally, an event may specify extra parameters via the [[params]] property.
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @since 2.0
|
|
|
|
*/
|
|
|
|
class Event extends Component
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var object the sender of this event
|
|
|
|
*/
|
|
|
|
public $sender;
|
|
|
|
/**
|
|
|
|
* @var boolean whether the event is handled. Defaults to false.
|
|
|
|
* When a handler sets this to be true, the rest of the uninvoked event handlers will be canceled.
|
|
|
|
*/
|
|
|
|
public $handled = false;
|
|
|
|
/**
|
|
|
|
* @var mixed extra parameters associated with the event.
|
|
|
|
*/
|
|
|
|
public $params;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
* @param mixed $sender sender of the event
|
|
|
|
*/
|
|
|
|
public function __construct($sender=null)
|
|
|
|
{
|
|
|
|
$this->sender = $sender;
|
|
|
|
}
|
|
|
|
}
|