TYPO3  7.6
Public Member Functions | Private Attributes | List of all members
Swift_Events_EventObject Class Reference
Inheritance diagram for Swift_Events_EventObject:
Swift_Events_Event Swift_Events_CommandEvent Swift_Events_ResponseEvent Swift_Events_SendEvent Swift_Events_TransportChangeEvent Swift_Events_TransportExceptionEvent

Public Member Functions

 __construct ($source)
 
 getSource ()
 
 cancelBubble ($cancel=true)
 
 bubbleCancelled ()
 

Private Attributes

 $_source
 
 $_bubbleCancelled = false
 

Detailed Description

A base Event which all Event classes inherit from.

Author
Chris Corbyn

Definition at line 16 of file EventObject.php.

Constructor & Destructor Documentation

__construct (   $source)

Create a new EventObject originating at $source.

Parameters
object$source

Definition at line 29 of file EventObject.php.

Member Function Documentation

bubbleCancelled ( )

Returns true if this Event will not bubble any further up the stack.

Returns
bool

Implements Swift_Events_Event.

Definition at line 59 of file EventObject.php.

References $_bubbleCancelled.

Referenced by Swift_Events_SimpleEventDispatcher\_bubble().

cancelBubble (   $cancel = true)

Prevent this Event from bubbling any further up the stack.

Parameters
bool$cancel,optional

Implements Swift_Events_Event.

Definition at line 49 of file EventObject.php.

Referenced by Swift_Plugins_LoggerPlugin\exceptionThrown().

getSource ( )

Member Data Documentation

$_bubbleCancelled = false
private

The state of this Event (should it bubble up the stack?)

Definition at line 22 of file EventObject.php.

Referenced by bubbleCancelled().

$_source
private

The source of this Event

Definition at line 19 of file EventObject.php.

Referenced by getSource().