Bdf\Prime\ConnectionManager

Complexity

Total Complexity

26

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Test Coverage

Coverage

92.73%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	2
A	getDefaultConnection()	0	3	1
A	addConnection()	0	13	4
A	removeConnection()	0	8	2
A	getConnectionNames()	0	3	1
A	setDefaultConnection()	0	3	1
A	connectionNames()	0	3	1
A	getConnection()	0	12	4
A	connection()	0	3	1
A	config()	0	9	2
A	declareConnection()	0	4	2
A	getCurrentConnectionNames()	0	3	1
A	connections()	0	3	1
A	loadSubConnection()	0	17	3

<?php

namespace Bdf\Prime;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Connection\ConnectionRegistry;
use Bdf\Prime\Connection\SubConnectionManagerInterface;
use Bdf\Prime\Exception\DBALException;
use LogicException;

/**
 * ConnectionManager
 * 
 * doctrine dbal connection registry

Doc comment long description must start with a capital letter

Doc comment long description must end with a full stop

 */
class ConnectionManager implements ConnectionRegistryInterface
{
    /**
     * The connection registry
     *
     * @var ConnectionRegistryInterface
     */
    private $registry;

    /**
     * Connections list
     *
     * @var ConnectionInterface[]
     */
    private $connections = [];

    /**
     * Default connection to use
     * 
     * @var string 

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

     */
    private $defaultConnection;


    /**
     * Set default configuration
     *
     * @param ConnectionRegistryInterface $registry
     */
    public function __construct(ConnectionRegistryInterface $registry = null)

Expected 1 blank line before function; 2 found

    {
        $this->registry = $registry ?: new ConnectionRegistry();

The value of a comparison must not be assigned to a variable

Inline shorthand IF statement requires brackets around comparison

    }

    /**
     * Add database connection
     *
     * @param ConnectionInterface $connection Unique name for the connection
     * @param boolean             $default    Use this connection as the default? The first connection added is automatically set as the default, even if this flag is false.

Expected "bool" but found "boolean" for parameter type

     *
     * @throws LogicException if connection exists

@throws comment must be on the next line

@throws tag comment must start with a capital letter

@throws tag comment must end with a full stop

     */
    public function addConnection(ConnectionInterface $connection, bool $default = false)
    {
        // Connection name must be unique
        if (isset($this->connections[$connection->getName()])) {
            throw new LogicException('Connection for "'.$connection->getName().'" already exists. Connection name must be unique.');
        }

        // Set as default connection?
        if (true === $default || null === $this->defaultConnection) {
            $this->defaultConnection = $connection->getName();
        }

        $this->connections[$connection->getName()] = $connection;
    }

    /**
     * Remove a connection by its name
     *
     * @param string $name
     */
    public function removeConnection(string $name)
    {
        if (!isset($this->connections[$name])) {
            return;
        }
        
        $this->connections[$name]->close();

The method close() does not exist on Bdf\Prime\Connection\ConnectionInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Connection\ConnectionInterface.

        unset($this->connections[$name]);
    }

    /**
     * Get connection by name
     *
     * @param string $name Unique name of the connection to be returned
     * 
     * @return ConnectionInterface
     * 
     * @throws DBALException
     *
     * @deprecated Since 1.1 use getConnection

Each @deprecated tag must have a @see tag immediately following it.

The text '@deprecated Since 1.1 use getConnection' does not match the standard format: @deprecated in deprecation-version and is removed from removal-version. extra-info.

     */
    public function connection(string $name = null): ConnectionInterface
    {
        return $this->getConnection($name);
    }

    /**

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

     * {@inheritDoc}
     */
    public function getConnection(string $name = null): ConnectionInterface
    {
        if ($name === null) {
            $name = $this->defaultConnection;
        }

        // Connection name must be unique
        if (!isset($this->connections[$name]) && !$this->loadSubConnection($name)) {
            $this->addConnection($this->registry->getConnection($name));
        }

        return $this->connections[$name];
    }

    /**
     * Associate configuration to connection
     *
     * @param string $connectionName
     * @param string|array $parameters
     */
    public function declareConnection(string $connectionName, $parameters)
    {
        if ($this->registry instanceof ConnectionRegistry) {
            $this->registry->declareConnection($connectionName, $parameters);
        }
    }

    /**
     * Get global config
     *
     * @return Configuration
     *
     * @deprecated Every connection should have its config.

Each @deprecated tag must have a @see tag immediately following it.

The text '@deprecated Every connection should have its config.' does not match the standard format: @deprecated in deprecation-version and is removed from removal-version. extra-info.

     */
    public function config(): Configuration
    {
        @trigger_error(__METHOD__.' is deprecated since 1.1 and will be removed in 1.2. Every connection should have its config.', E_USER_DEPRECATED);

Silencing errors is discouraged; found: @trigger_error(__METHOD__...

The trigger_error message '__METHOD__ is deprecated since 1.1 and will be removed in 1.2. Every connection should have its config.' does not match the strict standard format: thing is deprecated in deprecation-version and is removed from removal-version. extra-info. See cr-link

        if ($this->registry instanceof ConnectionRegistry) {
            return $this->registry->getDefaultConfiguration();
        }

        return new Configuration();
    }

    /**
     * Get all connections
     *
     * @return ConnectionInterface[] Array of connection objects
     */
    public function connections()
    {
        return $this->connections;
    }

    /**
     * {@inheritDoc}
     */
    public function getConnectionNames(): array
    {
        return array_unique(array_merge($this->getCurrentConnectionNames(), $this->registry->getConnectionNames()));
    }

Expected 1 blank line after function; 0 found

    /**
     * Get the loaded connection name
     *
     * @return string[] Array of connection name
     *
     * @deprecated Since 1.1 use getConnectionNames

Each @deprecated tag must have a @see tag immediately following it.

The text '@deprecated Since 1.1 use getConnectionNames' does not match the standard format: @deprecated in deprecation-version and is removed from removal-version. extra-info.

     */
    public function connectionNames(): array
    {
        return $this->getConnectionNames();
    }

    /**
     * Gets the name of connections in progress
     */
    public function getCurrentConnectionNames(): array
    {
        return array_keys($this->connections);
    }

    /**
     * Set the default connection name
     *
     * @param string $name
     */
    public function setDefaultConnection($name)
    {
        $this->defaultConnection = $name;
    }

    /**
     * Get the default connection name
     *
     * @return string
     */
    public function getDefaultConnection()
    {
        return $this->defaultConnection;
    }

    /**
     * Try to load a sub connection
     *
     * This method allows connection as "name.otherName".
     * Works only if connection "name" is a SubConnectionManagerInterface.
     *
     * @param string $connectionName
     * 
     * @return bool  The connection has been loaded

Expected "boolean" but found "bool" for function return type

     */
    private function loadSubConnection($connectionName)

Private method name "ConnectionManager::loadSubConnection" must be prefixed with an underscore

    {
        $names = explode('.', $connectionName, 2);

        if (!isset($names[1])) {
            return false;
        }

        $connection = $this->getConnection($names[0]);

        if ($connection instanceof SubConnectionManagerInterface) {
            //TODO doit on concerver une reference sur la sous connection ?

No space found before comment text; expected "// TODO doit on concerver une reference sur la sous connection ?" but found "//TODO doit on concerver une reference sur la sous connection ?"

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

            $this->connections[$connectionName] = $connection->getConnection($names[1]);
            return true;
        }

        return false;
    }
}