<?php /** * @link http://www.yiiframework.com/ * @copyright Copyright (c) 2008 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, when attaching an event handler, extra data may be passed * and be available via the [[data]] property when the event handler is invoked. * * @author Qiang Xue <qiang.xue@gmail.com> * @since 2.0 */ class Event extends Object { /** * @var string the event name. This property is set by [[Component::trigger()]]. * Event handlers may use this property to check what event it is handling. */ public $name; /** * @var object the sender of this event. If not set, this property will be * set as the object whose "trigger()" method is called. */ public $sender; /** * @var boolean whether the event is handled. Defaults to false. * When a handler sets this to be true, the event processing will stop and * ignore the rest of the uninvoked event handlers. */ public $handled = false; /** * @var mixed the data that is passed to [[Component::on()]] when attaching an event handler. * Note that this varies according to which event handler is currently executing. */ public $data; }