Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Events_EventObject

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Events/EventObject.php

Class Overview


A base Event which all Event classes inherit from.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods


Child classes:

Swift_Events_CommandEvent
Generated when a command is sent over an SMTP connection.
Swift_Events_ResponseEvent
Generated when a response is received on a SMTP connection.
Swift_Events_SendEvent
Generated when a message is being sent.
Swift_Events_TransportChangeEvent
Generated when the state of a Transport is changed (i.e. stopped/started).
Swift_Events_TransportExceptionEvent
Generated when a TransportException is thrown from the Transport system.

Class Details

[line 16]
A base Event which all Event classes inherit from.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 29]

Swift_Events_EventObject __construct( object $source)

Create a new EventObject originating at $source.



Tags:

access:  public


Overridden in child classes as:

Swift_Events_CommandEvent::__construct()
Create a new CommandEvent for $source with $command.
Swift_Events_ResponseEvent::__construct()
Create a new ResponseEvent for $source and $response.
Swift_Events_SendEvent::__construct()
Create a new SendEvent for $source and $message.
Swift_Events_TransportExceptionEvent::__construct()
Create a new TransportExceptionEvent for $transport.

Parameters:

object   $source  

[ Top ]

method bubbleCancelled [line 59]

bool bubbleCancelled( )

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



Tags:

access:  public



Implementation of:
Swift_Events_Event::bubbleCancelled()
Returns true if this Event will not bubble any further up the stack.
[ Top ]

method cancelBubble [line 49]

void cancelBubble( [ $cancel = true], bool $cancel,)

Prevent this Event from bubbling any further up the stack.



Tags:

access:  public



Implementation of:
Swift_Events_Event::cancelBubble()
Prevent this Event from bubbling any further up the stack.

Parameters:

bool   $cancel,   optional
   $cancel  

[ Top ]

method getSource [line 39]

object getSource( )

Get the source object of this event.



Tags:

access:  public



Implementation of:
Swift_Events_Event::getSource()
Get the source object of this event.
[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:48:35 +0000 by phpDocumentor 1.4.3