dolibarr/htdocs/includes/swiftmailer/lib/classes/Swift/Events/SimpleEventDispatcher.php

143 lines
4.3 KiB
PHP
Raw Normal View History

2016-04-16 18:15:03 +02:00
<?php
/*
* This file is part of SwiftMailer.
* (c) 2004-2009 Chris Corbyn
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* The EventDispatcher which handles the event dispatching layer.
*
* @author Chris Corbyn
*/
class Swift_Events_SimpleEventDispatcher implements Swift_Events_EventDispatcher
{
/** A map of event types to their associated listener types */
2021-12-07 17:11:34 +01:00
private $eventMap = [];
2016-04-16 18:15:03 +02:00
/** Event listeners bound to this dispatcher */
2021-12-07 17:11:34 +01:00
private $listeners = [];
2016-04-16 18:15:03 +02:00
/**
* Create a new EventDispatcher.
*/
public function __construct()
{
2021-12-07 17:11:34 +01:00
$this->eventMap = [
2016-04-16 18:15:03 +02:00
'Swift_Events_CommandEvent' => 'Swift_Events_CommandListener',
'Swift_Events_ResponseEvent' => 'Swift_Events_ResponseListener',
'Swift_Events_SendEvent' => 'Swift_Events_SendListener',
'Swift_Events_TransportChangeEvent' => 'Swift_Events_TransportChangeListener',
'Swift_Events_TransportExceptionEvent' => 'Swift_Events_TransportExceptionListener',
2021-12-07 17:11:34 +01:00
];
2016-04-16 18:15:03 +02:00
}
/**
* Create a new SendEvent for $source and $message.
*
* @return Swift_Events_SendEvent
*/
2018-01-21 15:55:56 +01:00
public function createSendEvent(Swift_Transport $source, Swift_Mime_SimpleMessage $message)
2016-04-16 18:15:03 +02:00
{
return new Swift_Events_SendEvent($source, $message);
}
/**
* Create a new CommandEvent for $source and $command.
*
2021-12-07 17:11:34 +01:00
* @param string $command That will be executed
* @param array $successCodes That are needed
2016-04-16 18:15:03 +02:00
*
* @return Swift_Events_CommandEvent
*/
2021-12-07 17:11:34 +01:00
public function createCommandEvent(Swift_Transport $source, $command, $successCodes = [])
2016-04-16 18:15:03 +02:00
{
return new Swift_Events_CommandEvent($source, $command, $successCodes);
}
/**
* Create a new ResponseEvent for $source and $response.
*
2021-12-07 17:11:34 +01:00
* @param string $response
* @param bool $valid If the response is valid
2016-04-16 18:15:03 +02:00
*
* @return Swift_Events_ResponseEvent
*/
public function createResponseEvent(Swift_Transport $source, $response, $valid)
{
return new Swift_Events_ResponseEvent($source, $response, $valid);
}
/**
* Create a new TransportChangeEvent for $source.
*
* @return Swift_Events_TransportChangeEvent
*/
public function createTransportChangeEvent(Swift_Transport $source)
{
return new Swift_Events_TransportChangeEvent($source);
}
/**
* Create a new TransportExceptionEvent for $source.
*
* @return Swift_Events_TransportExceptionEvent
*/
public function createTransportExceptionEvent(Swift_Transport $source, Swift_TransportException $ex)
{
return new Swift_Events_TransportExceptionEvent($source, $ex);
}
/**
* Bind an event listener to this dispatcher.
*/
public function bindEventListener(Swift_Events_EventListener $listener)
{
2018-01-21 15:55:56 +01:00
foreach ($this->listeners as $l) {
2016-04-16 18:15:03 +02:00
// Already loaded
if ($l === $listener) {
return;
}
}
2018-01-21 15:55:56 +01:00
$this->listeners[] = $listener;
2016-04-16 18:15:03 +02:00
}
/**
* Dispatch the given Event to all suitable listeners.
*
2021-12-07 17:11:34 +01:00
* @param string $target method
2016-04-16 18:15:03 +02:00
*/
public function dispatchEvent(Swift_Events_EventObject $evt, $target)
{
2021-12-07 17:11:34 +01:00
$bubbleQueue = $this->prepareBubbleQueue($evt);
$this->bubble($bubbleQueue, $evt, $target);
2016-04-16 18:15:03 +02:00
}
/** Queue listeners on a stack ready for $evt to be bubbled up it */
2018-01-21 15:55:56 +01:00
private function prepareBubbleQueue(Swift_Events_EventObject $evt)
2016-04-16 18:15:03 +02:00
{
2021-12-07 17:11:34 +01:00
$bubbleQueue = [];
$evtClass = \get_class($evt);
2018-01-21 15:55:56 +01:00
foreach ($this->listeners as $listener) {
2021-12-07 17:11:34 +01:00
if (\array_key_exists($evtClass, $this->eventMap)
2018-01-21 15:55:56 +01:00
&& ($listener instanceof $this->eventMap[$evtClass])) {
2021-12-07 17:11:34 +01:00
$bubbleQueue[] = $listener;
2016-04-16 18:15:03 +02:00
}
}
2021-12-07 17:11:34 +01:00
return $bubbleQueue;
2016-04-16 18:15:03 +02:00
}
/** Bubble $evt up the stack calling $target() on each listener */
2021-12-07 17:11:34 +01:00
private function bubble(array &$bubbleQueue, Swift_Events_EventObject $evt, $target)
2016-04-16 18:15:03 +02:00
{
2021-12-07 17:11:34 +01:00
if (!$evt->bubbleCancelled() && $listener = array_shift($bubbleQueue)) {
2016-04-16 18:15:03 +02:00
$listener->$target($evt);
2021-12-07 17:11:34 +01:00
$this->bubble($bubbleQueue, $evt, $target);
2016-04-16 18:15:03 +02:00
}
}
}