Doctrine\DBAL\Driver\PDOSqlsrv\Driver

Complexity

Total Complexity

12

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Test Coverage

Coverage

6.45%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	connect()	0	7	1
B	_constructPdoDsn()	0	21	6
A	getDsnParams()	0	14	3
A	getAvailableDsnParam()	0	18	1

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Driver\PDOSqlsrv;

use Doctrine\DBAL\Driver\AbstractSQLServerDriver;
use function array_change_key_case;
use function sprintf;
use function strtolower;

/**
 * The PDO-based Sqlsrv driver.
 *
 * @since 2.0
 */
class Driver extends AbstractSQLServerDriver
{
    /**
     * {@inheritdoc}
     */
    public function connect(array $params, $username = null, $password = null, array $driverOptions = [])
    {
        return new Connection(
            $this->_constructPdoDsn($params),
            $username,
            $password,
            $driverOptions
        );
    }

    /**
     * Constructs the Sqlsrv PDO DSN.
     *
     * @param array $params
     *
     * @return string The DSN.
     */
    private function _constructPdoDsn(array $params)
    {
        $dsn = 'sqlsrv:server=';

        if (isset($params['host'])) {
            $dsn .= $params['host'];
        }

        if (isset($params['port']) && !empty($params['port'])) {
            $dsn .= ',' . $params['port'];
        }

        if (isset($params['dbname'])) {
            $dsn .= ';Database=' . $params['dbname'];
        }

        foreach ($this->getDsnParams($params) as $dsnParamName => $dsnParamValue) {
            $dsn .= sprintf(';%s=%s', $dsnParamName, $dsnParamValue);
        }

        return $dsn;
    }

    /**
     * Returns present dsn params
     *
     * @param string[] $params
     *
     * @return string[] Present DSN params
     */
    private function getDsnParams(array $params)
    {
        $dsnParams          = [];
        $availableDsnParams = $this->getAvailableDsnParam();
        $paramsLowercase    = array_change_key_case($params);

        foreach ($availableDsnParams as $availableDsnParamName) {
            $availableDsnParamValue = $paramsLowercase[strtolower($availableDsnParamName)] ?? null;
            if (! isset($availableDsnParamValue)) {
                continue;
            }
            $dsnParams[$availableDsnParamName] = $availableDsnParamValue;
        }
        return $dsnParams;
    }

    /**
     * Returns available DSN params for driver
     *
     * @return string[] Available DSN params
     */
    private function getAvailableDsnParam()
    {
        return [
            'APP',
            'ConnectionPooling',
            'Encrypt',
            'Failover_Partner',
            'LoginTimeout',
            'MultipleActiveResultSets',
            'QuotedId',
            'Server',
            'TraceFile',
            'TraceOn',
            'TransactionIsolation',
            'TrustServerCertificate',
            'WSID',
            'ApplicationIntent',
            'MultiSubnetFailover',
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'pdo_sqlsrv';
    }
}