Bdf\Prime\Connection\MasterSlaveConnection

Complexity

Total Complexity

12

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Test Coverage

Coverage

85.19%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	force()	0	5	1
A	executeQuery()	0	9	3
A	getConnection()	0	12	3
A	close()	0	5	1
A	quote()	0	3	1
A	getReadConnection()	0	3	1
A	__construct()	0	9	2

<?php

namespace Bdf\Prime\Connection;

use Bdf\Prime\ConnectionManager;

Unused use statement

use Doctrine\Common\EventManager;
use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\Driver;
use LogicException;

/**
 * MasterSlaveConnection
 *
 * The master / slave connection is a connection to a master server with a connection wrapper to a slave server.
 * Only method SimpleConnection#executeQuery will be redirect to the salve.
 *
 * SimpleConnection#quote also use slave.
 *
 * Becareful those methods are used on master:
 *
 *   SimpleConnection#prepare
 *   SimpleConnection#query
 *
 * @package Bdf\Prime\Connection

@package tag is not allowed in class comment

 */
class MasterSlaveConnection extends SimpleConnection implements SubConnectionManagerInterface
{
    /**
     * The connection specifically for read operations
     * 
     * This connection is used only for the method SimpleConnection#executeQuery

Doc comment long description must end with a full stop

     * 
     * @var SimpleConnection
     */
    private $readConnection;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * Force the read on master
     *
     * @var boolean

Expected "bool" but found "boolean" for @var tag in member variable comment

     */
    private $force = false;

    /**
     * Initializes a new instance of the Connection class.
     * 
     * Here's a read connection configuration

Doc comment long description must end with a full stop

     * 
     * @example
     *
     * $conn = DriverManager::getConnection([
     *    'driver' => 'pdo_mysql',
     *    'user'     => '',
     *    'password' => '',
     *    'host'     => '',
     *    'dbname'   => '',
     *    'read' => [
     *        'user'     => 'slave',
     *        'password' => '',
     *        'host'     => '',
     *        'dbname'   => '',
     *    ]
     * ]);
     *
     * @param array                              $params       The connection parameters.

Parameter tags must be defined first in a doc comment

     * @param \Doctrine\DBAL\Driver              $driver       The driver to use.
     * @param \Doctrine\DBAL\Configuration|null  $config       The configuration, optional.
     * @param \Doctrine\Common\EventManager|null $eventManager The event manager, optional.
     */

Missing @throws tag in function comment

    public function __construct(array $params, Driver $driver, Configuration $config = null, EventManager $eventManager = null)
    {
        if (!isset($params['read'])) {
            throw new LogicException('Master/slave connection needs readable connection in parameters');
        }

        $this->readConnection = $params['read'];

        parent::__construct($params, $driver, $config, $eventManager);
    }

    /**
     * Get the read connection
     * 
     * @return SimpleConnection
     */
    public function getReadConnection()
    {
        return $this->readConnection;
    }

    /**

Parameter $name should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @throws tag in function comment

    public function getConnection($name)
    {
        if ($name === 'read') {
            return $this->readConnection;
        }

        // Force the read on master if it is the awaiting connection
        if ($name === 'master') {
            return $this->force();
        }

        throw new LogicException('The sub connection "'.$name.'" is unknown in the master / slave connection');
    }

    /**
     * Force next read on master connection once
     * This flag will change after the execution of method executeQuery

Doc comment short description must be on a single line, further text should be a separate paragraph

     *
     * @return $this
     */
    public function force()
    {
        $this->force = true;

        return $this;
    }

    /**

Parameter $query should have a doc-comment as per coding-style.

Parameter $params should have a doc-comment as per coding-style.

Parameter $types should have a doc-comment as per coding-style.

Parameter $qcp should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function executeQuery($query, array $params = [], $types = [], QueryCacheProfile $qcp = null)
    {
        if ($this->getTransactionNestingLevel() <= 0 && $this->force !== true) {
            return $this->readConnection->executeQuery($query, $params, $types, $qcp);
        }

        $this->force = false;

        return parent::executeQuery($query, $params, $types, $qcp);
    }

    /**

Parameter $input should have a doc-comment as per coding-style.

Parameter $type should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    public function quote($input, $type = null)
    {
        return $this->readConnection->quote($input, $type);
    }

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        parent::close();

        $this->readConnection->close();
    }
}