Swift_Transport_LoadBalancedTransport

Complexity

Total Complexity

25

Size/Duplication

Total Lines	209
Duplicated Lines	15.31 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

84.48%

Importance

Changes	6
Bugs	2	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setTransports()	0	5	1
A	getTransports()	0	4	1
A	getLastUsedTransport()	0	4	1
A	isStarted()	0	4	1
A	start()	0	4	1
A	stop()	0	6	2
A	ping()	0	10	3
C	send()	32	32	7
A	registerPlugin()	0	6	2
A	_getNextTransport()	0	9	2
A	_killCurrentTransport()	0	13	3

<?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.
 */

/**
 * Redundantly and rotationally uses several Transports when sending.
 *
 * @author Chris Corbyn
 */
class Swift_Transport_LoadBalancedTransport implements Swift_Transport

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * Transports which are deemed useless.
     *
     * @var Swift_Transport[]
     */
    private $_deadTransports = array();

    /**
     * The Transports which are used in rotation.
     *
     * @var Swift_Transport[]
     */
    protected $_transports = array();

    /**
     * The Transport used in the last successful send operation.
     *
     * @var Swift_Transport
     */
    protected $_lastUsedTransport;

    // needed as __construct is called from elsewhere explicitly
    public function __construct()
    {
    }

    /**
     * Set $transports to delegate to.
     *
     * @param Swift_Transport[] $transports
     */
    public function setTransports(array $transports)
    {
        $this->_transports = $transports;
        $this->_deadTransports = array();
    }

    /**
     * Get $transports to delegate to.
     *
     * @return Swift_Transport[]
     */
    public function getTransports()
    {
        return array_merge($this->_transports, $this->_deadTransports);
    }

    /**
     * Get the Transport used in the last successful send operation.
     *
     * @return Swift_Transport
     */
    public function getLastUsedTransport()
    {
        return $this->_lastUsedTransport;
    }

    /**
     * Test if this Transport mechanism has started.
     *
     * @return bool
     */
    public function isStarted()
    {
        return count($this->_transports) > 0;
    }

    /**
     * Start this Transport mechanism.
     */
    public function start()
    {
        $this->_transports = array_merge($this->_transports, $this->_deadTransports);
    }

    /**
     * Stop this Transport mechanism.
     */
    public function stop()
    {
        foreach ($this->_transports as $transport) {
            $transport->stop();
        }
    }

    /**
     * Check if this Transport mechanism is alive.
     *
     * If a Transport mechanism session is no longer functional, the method
     * returns FALSE. It is the responsibility of the developer to handle this
     * case and restart the Transport mechanism manually.
     *
     * @example
     *
     *   if (!$transport->ping()) {
     *      $transport->stop();
     *      $transport->start();
     *   }
     *
     * The Transport mechanism will be started, if it is not already.
     *
     * It is undefined if the Transport mechanism attempts to restart as long as
     * the return value reflects whether the mechanism is now functional.
     *
     * @return bool TRUE if the transport is alive
     */
    public function ping()
    {
        foreach ($this->transports as $transport) {

The property transports does not seem to exist. Did you mean _deadTransports?

            if (!$transport->ping()) {
                $this->killCurrentTransport();

The method killCurrentTransport() does not exist on Swift_Transport_LoadBalancedTransport. Did you maybe mean _killCurrentTransport()?

            }
        }

        return count($this->transports) > 0;

The property transports does not seem to exist. Did you mean _deadTransports?

    }

    /**
     * Send the given Message.
     *
     * Recipient/sender data will be retrieved from the Message API.
     * The return value is the number of recipients who were accepted for delivery.
     *
     * @param Swift_Mime_Message $message
     * @param string[]           $failedRecipients An array of failures by-reference
     *
     * @return int
     *
     * @throws Swift_TransportException
     */
    public function send(Swift_Mime_Message $message, &$failedRecipients = null)

This method seems to be duplicated in your project.

    {
        $maxTransports = count($this->_transports);
        $sent = 0;
        $this->_lastUsedTransport = null;

        for ($i = 0; $i < $maxTransports
                     && $transport = $this->_getNextTransport(); ++$i) {
            try {
                if (!$transport->isStarted()) {
                    $transport->start();
                }

                $sent = $transport->send($message, $failedRecipients);
                if ($sent) {
                    $this->_lastUsedTransport = $transport;
                    break;
                }

            } catch (Swift_TransportException $e) {
                $this->_killCurrentTransport();
            }
        }

        if (count($this->_transports) === 0) {
            throw new Swift_TransportException(
                'All Transports in LoadBalancedTransport failed, or no Transports available'
            );
        }

        return $sent;
    }

    /**
     * Register a plugin.
     *
     * @param Swift_Events_EventListener $plugin
     */
    public function registerPlugin(Swift_Events_EventListener $plugin)
    {
        foreach ($this->_transports as $transport) {
            $transport->registerPlugin($plugin);
        }
    }

    /**
     * Rotates the transport list around and returns the first instance.
     *
     * @return Swift_Transport
     */
    protected function _getNextTransport()
    {
        $next = array_shift($this->_transports);
        if ($next) {
            $this->_transports[] = $next;
        }

        return $next;
    }

    /**
     * Tag the currently used (top of stack) transport as dead/useless.
     */
    protected function _killCurrentTransport()
    {
        $transport = array_pop($this->_transports);
        if ($transport) {

            try {
                $transport->stop();
            } catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

            }

            $this->_deadTransports[] = $transport;
        }
    }
}