/framework/vendor/swift/lib/classes/Swift/Events/Event.php

 1<?php
 2
 3/*
 4 * This file is part of SwiftMailer.
 5 * (c) 2004-2009 Chris Corbyn
 6 *
 7 * For the full copyright and license information, please view the LICENSE
 8 * file that was distributed with this source code.
 9 */
10
11/**
12 * The minimum interface for an Event.
13 * 
14 * @package Swift
15 * @subpackage Events
16 * @author Chris Corbyn
17 */
18interface Swift_Events_Event
19{
20  
21  /**
22   * Get the source object of this event.
23   * @return object
24   */
25  public function getSource();
26  
27  /**
28   * Prevent this Event from bubbling any further up the stack.
29   * @param boolean $cancel, optional
30   */
31  public function cancelBubble($cancel = true);
32  
33  /**
34   * Returns true if this Event will not bubble any further up the stack.
35   * @return boolean
36   */
37  public function bubbleCancelled();
38  
39}