[Summary view] [Print] [Text view]

   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   * Interface for the EventDispatcher which handles the event dispatching layer.
  13   *
  14   * @author Chris Corbyn
  15   */
  16  interface Swift_Events_EventDispatcher
  17  {
  18      /**
  19       * Create a new SendEvent for $source and $message.
  20       *
  21       * @param Swift_Mime_SimpleMessage
  22       *
  23       * @return Swift_Events_SendEvent
  24       */
  25      public function createSendEvent(Swift_Transport $source, Swift_Mime_SimpleMessage $message);
  26  
  27      /**
  28       * Create a new CommandEvent for $source and $command.
  29       *
  30       * @param string $command      That will be executed
  31       * @param array  $successCodes That are needed
  32       *
  33       * @return Swift_Events_CommandEvent
  34       */
  35      public function createCommandEvent(Swift_Transport $source, $command, $successCodes = []);
  36  
  37      /**
  38       * Create a new ResponseEvent for $source and $response.
  39       *
  40       * @param string $response
  41       * @param bool   $valid    If the response is valid
  42       *
  43       * @return Swift_Events_ResponseEvent
  44       */
  45      public function createResponseEvent(Swift_Transport $source, $response, $valid);
  46  
  47      /**
  48       * Create a new TransportChangeEvent for $source.
  49       *
  50       * @return Swift_Events_TransportChangeEvent
  51       */
  52      public function createTransportChangeEvent(Swift_Transport $source);
  53  
  54      /**
  55       * Create a new TransportExceptionEvent for $source.
  56       *
  57       * @return Swift_Events_TransportExceptionEvent
  58       */
  59      public function createTransportExceptionEvent(Swift_Transport $source, Swift_TransportException $ex);
  60  
  61      /**
  62       * Bind an event listener to this dispatcher.
  63       */
  64      public function bindEventListener(Swift_Events_EventListener $listener);
  65  
  66      /**
  67       * Dispatch the given Event to all suitable listeners.
  68       *
  69       * @param string $target method
  70       */
  71      public function dispatchEvent(Swift_Events_EventObject $evt, $target);
  72  }