Bdf\Prime\Connection\Factory\ConnectionFactory

Complexity

Total Complexity

14

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Test Coverage

Coverage

86.67%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	support()	0	3	1
A	unregisterDriverMap()	0	3	1
B	createConnection()	0	28	7
A	getDriverMap()	0	5	2
A	registerDriverMap()	0	3	1
A	create()	0	10	2

<?php

namespace Bdf\Prime\Connection\Factory;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Connection\SimpleConnection;
use Bdf\Prime\Exception\DBALException;
use Bdf\Prime\Exception\PrimeException;
use Doctrine\Common\EventManager;
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\DBALException as DoctrineDBALException;
use Doctrine\DBAL\DriverManager;

/**
 * ConnectionFactory
 *
 * Create simple connection instance

Doc comment long description must end with a full stop

 */
class ConnectionFactory implements ConnectionFactoryInterface
{
    /**
     * The drivers map
     *
     * @var array
     */
    static private $driversMap;

The static declaration must come after the visibility declaration

    /**

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

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

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

     * {@inheritDoc}
     */
    public function create(string $connectionName, array $parameters, Configuration $config): ConnectionInterface
    {
        $connection = $this->createConnection($parameters, $config);

        // Store connection and return adapter instance
        if ($connection instanceof ConnectionInterface) {

$connection is always a sub-type of Bdf\Prime\Connection\ConnectionInterface.

            $connection->setName($connectionName);
        }

        return $connection;
    }

    /**

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

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

     * {@inheritDoc}
     */
    public function support(string $connectionName, array $parameters): bool
    {
        return true;
    }

    /**
     * Create the instance of the connection
     *
     * @param array $parameters
     * @param Configuration|null $config
     * @param EventManager|null $eventManager The event manager, optional.
     *
     * @return ConnectionInterface
     * @throws DBALException

Comment missing for @throws tag in function comment

     */
    private function createConnection(array $parameters, Configuration $config = null, EventManager $eventManager = null): ConnectionInterface

Private method name "ConnectionFactory::createConnection" must be prefixed with an underscore

    {
        // Set the custom driver class + wrapper
        if (isset($parameters['driver']) && isset(self::$driversMap[$parameters['driver']])) {
            list($parameters['driverClass'], $parameters['wrapperClass']) = self::$driversMap[$parameters['driver']];
            unset($parameters['driver']);
        }

        // Replace 'adapter' with 'driver' and add 'pdo_'
        if (isset($parameters['adapter'])) {
            $parameters['driver'] = 'pdo_' . $parameters['adapter'];
            unset($parameters['adapter']);
        }

        // default charset

Inline comments must start with a capital letter

        if (!isset($parameters['charset'])) {
            $parameters['charset'] = 'utf8';
        }

        // default wrapper

Inline comments must start with a capital letter

        if (!isset($parameters['wrapperClass'])) {
            $parameters['wrapperClass'] = SimpleConnection::class;
        }

        try {
            return DriverManager::getConnection($parameters, $config, $eventManager);

The expression return Doctrine\DBAL\DriverManager::getConnection($parameters, $config, $eventManager) returns the type Doctrine\DBAL\Connection which is incompatible with the type-hinted return Bdf\Prime\Connection\ConnectionInterface.

        } catch (DoctrineDBALException $e) {
            throw new DBALException('Cannot create the connection : '.$e->getMessage(), $e->getCode(), $e);
        }
    }

    /**
     * Register a global driver map
     *
     * @param string $name
     * @param string $driver
     * @param string|null $wrapper
     */
    public static function registerDriverMap($name, $driver, $wrapper = null)
    {
        self::$driversMap[$name] = [$driver, $wrapper];
    }

    /**
     * Get a global driver map
     *
     * @param string $name
     *
     * @return string|null
     */
    public static function getDriverMap($name)
    {
        return isset(self::$driversMap[$name])
            ? self::$driversMap[$name]

Inline shorthand IF statement must be declared on a single line

            : null;
    }

    /**
     * Unregister a global driver map
     *
     * @param string $name
     */
    public static function unregisterDriverMap($name)
    {
        unset(self::$driversMap[$name]);
    }
}