AbstractPostgreSQLDriver::getDatabase() - Code Metrics - Inspection of "Merge pull request #3606 from morozov/issues/3592" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( dcb0ff...425513 )

by Sergei

created 2019-06-13 04:16 UTC

AbstractPostgreSQLDriver::getDatabase() A

↳ Parent: AbstractPostgreSQLDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

declare(strict_types=1);

namespace Doctrine\DBAL\Driver;

use Doctrine\DBAL\Connection;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Doctrine\DBAL\Driver;
use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
use Doctrine\DBAL\Exception;
use Doctrine\DBAL\Exception\DriverException;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Platforms\Exception\InvalidPlatformVersion;
use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
use Doctrine\DBAL\Platforms\PostgreSqlPlatform;
use Doctrine\DBAL\Schema\AbstractSchemaManager;
use Doctrine\DBAL\Schema\PostgreSqlSchemaManager;
use Doctrine\DBAL\VersionAwarePlatformDriver;
use function preg_match;
use function strpos;
use function version_compare;

/**
 * Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for PostgreSQL based drivers.
 */
abstract class AbstractPostgreSQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
{
    /**
     * {@inheritdoc}
     *
     * @link http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
     */
    public function convertException(string $message, DriverExceptionInterface $exception) : DriverException
    {
        switch ($exception->getSQLState()) {
            case '40001':
            case '40P01':
                return new Exception\DeadlockException($message, $exception);
            case '0A000':
                // Foreign key constraint violations during a TRUNCATE operation
                // are considered "feature not supported" in PostgreSQL.
                if (strpos($exception->getMessage(), 'truncate') !== false) {
                    return new Exception\ForeignKeyConstraintViolationException($message, $exception);
                }

                break;
            case '23502':
                return new Exception\NotNullConstraintViolationException($message, $exception);

            case '23503':
                return new Exception\ForeignKeyConstraintViolationException($message, $exception);

            case '23505':
                return new Exception\UniqueConstraintViolationException($message, $exception);

            case '42601':
                return new Exception\SyntaxErrorException($message, $exception);

            case '42702':
                return new Exception\NonUniqueFieldNameException($message, $exception);

            case '42703':
                return new Exception\InvalidFieldNameException($message, $exception);

            case '42P01':
                return new Exception\TableNotFoundException($message, $exception);

            case '42P07':
                return new Exception\TableExistsException($message, $exception);
        }

        // In some case (mainly connection errors) the PDO exception does not provide a SQLSTATE via its code.
        // The exception code is always set to 7 here.
        // We have to match against the SQLSTATE in the error message in these cases.
        if ($exception->getCode() === 7 && strpos($exception->getMessage(), 'SQLSTATE[08006]') !== false) {
            return new Exception\ConnectionException($message, $exception);
        }

        return new DriverException($message, $exception);
    }

    /**
     * {@inheritdoc}
     */
    public function createDatabasePlatformForVersion(string $version) : AbstractPlatform
    {
        if (! preg_match('/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/', $version, $versionParts)) {
            throw InvalidPlatformVersion::new(
                $version,
                '<major_version>.<minor_version>.<patch_version>'
            );
        }

        $majorVersion = $versionParts['major'];
        $minorVersion = $versionParts['minor'] ?? 0;
        $patchVersion = $versionParts['patch'] ?? 0;
        $version      = $majorVersion . '.' . $minorVersion . '.' . $patchVersion;

        switch (true) {
            case version_compare($version, '10.0', '>='):
                return new PostgreSQL100Platform();
            case version_compare($version, '9.4', '>='):
                return new PostgreSQL94Platform();
            default:
                return new PostgreSqlPlatform();
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getDatabasePlatform() : AbstractPlatform
    {
        return new PostgreSqlPlatform();
    }

    /**
     * {@inheritdoc}
     */
    public function getSchemaManager(Connection $conn) : AbstractSchemaManager
    {
        return new PostgreSqlSchemaManager($conn);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\DBAL\Driver;
6
7		use Doctrine\DBAL\Connection;
		0 ignored issues – show Bug introduced 2018-02-11 17:01 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Doctrine\DBAL\Driver\Connection`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
8		use Doctrine\DBAL\Driver;
9		use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
10		use Doctrine\DBAL\Exception;
11		use Doctrine\DBAL\Exception\DriverException;
		0 ignored issues – show Bug introduced 2018-11-16 08:14 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Doctrine\DBAL\Driver\DriverException`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
12		use Doctrine\DBAL\Platforms\AbstractPlatform;
13		use Doctrine\DBAL\Platforms\Exception\InvalidPlatformVersion;
14		use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
15		use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
16		use Doctrine\DBAL\Platforms\PostgreSqlPlatform;
17		use Doctrine\DBAL\Schema\AbstractSchemaManager;
18		use Doctrine\DBAL\Schema\PostgreSqlSchemaManager;
19		use Doctrine\DBAL\VersionAwarePlatformDriver;
20		use function preg_match;
21		use function strpos;
22		use function version_compare;
23
24		/**
25		* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for PostgreSQL based drivers.
26		*/
27		abstract class AbstractPostgreSQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
28		{
29		/**
30		* {@inheritdoc}
31		*
32		* @link http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
33		*/
34	1297	public function convertException(string $message, DriverExceptionInterface $exception) : DriverException
35		{
36	1297	switch ($exception->getSQLState()) {
37	1297	case '40001':
38	1296	case '40P01':
39	1062	return new Exception\DeadlockException($message, $exception);
40	1295	case '0A000':
41		// Foreign key constraint violations during a TRUNCATE operation
42		// are considered "feature not supported" in PostgreSQL.
43	657	if (strpos($exception->getMessage(), 'truncate') !== false) {
44	657	return new Exception\ForeignKeyConstraintViolationException($message, $exception);
45		}
46
47		break;
48	1295	case '23502':
49	1186	return new Exception\NotNullConstraintViolationException($message, $exception);
50
51	1294	case '23503':
52	1261	return new Exception\ForeignKeyConstraintViolationException($message, $exception);
53
54	1293	case '23505':
55	1086	return new Exception\UniqueConstraintViolationException($message, $exception);
56
57	1292	case '42601':
58	1161	return new Exception\SyntaxErrorException($message, $exception);
59
60	1291	case '42702':
61	1211	return new Exception\NonUniqueFieldNameException($message, $exception);
62
63	1290	case '42703':
64	1236	return new Exception\InvalidFieldNameException($message, $exception);
65
66	1289	case '42P01':
67	1111	return new Exception\TableNotFoundException($message, $exception);
68
69	1288	case '42P07':
70	1286	return new Exception\TableExistsException($message, $exception);
71		}
72
73		// In some case (mainly connection errors) the PDO exception does not provide a SQLSTATE via its code.
74		// The exception code is always set to 7 here.
75		// We have to match against the SQLSTATE in the error message in these cases.
76	1287	if ($exception->getCode() === 7 && strpos($exception->getMessage(), 'SQLSTATE[08006]') !== false) {
77	1286	return new Exception\ConnectionException($message, $exception);
78		}
79
80	1011	return new DriverException($message, $exception);
81		}
82
83		/**
84		* {@inheritdoc}
85		*/
86	987	public function createDatabasePlatformForVersion(string $version) : AbstractPlatform
87		{
88	987	if (! preg_match('/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/', $version, $versionParts)) {
89	961	throw InvalidPlatformVersion::new(
90	961	$version,
91	961	'<major_version>.<minor_version>.<patch_version>'
92		);
93		}
94
95	986	$majorVersion = $versionParts['major'];
96	986	$minorVersion = $versionParts['minor'] ?? 0;
97	986	$patchVersion = $versionParts['patch'] ?? 0;
98	986	$version = $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
99
100		switch (true) {
101	986	case version_compare($version, '10.0', '>='):
102	986	return new PostgreSQL100Platform();
103	986	case version_compare($version, '9.4', '>='):
104	986	return new PostgreSQL94Platform();
105		default:
106	986	return new PostgreSqlPlatform();
107		}
108		}
109
110		/**
111		* {@inheritdoc}
112		*/
113	1311	public function getDatabasePlatform() : AbstractPlatform
114		{
115	1311	return new PostgreSqlPlatform();
116		}
117	1311
118		/**
119		* {@inheritdoc}
120		*/
121		public function getSchemaManager(Connection $conn) : AbstractSchemaManager
122		{
123	936	return new PostgreSqlSchemaManager($conn);
124		}
125		}
126

doctrine / dbal

Push — develop ( dcb0ff...425513 )

AbstractPostgreSQLDriver::getDatabase() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like