Passed
Pull Request — develop (#3606)
by Sergei
64:25
created

AbstractSQLiteDriver::getDatabase()   A

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 0
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
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 by
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 by
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\SqlitePlatform;
14
use Doctrine\DBAL\Schema\AbstractSchemaManager;
15
use Doctrine\DBAL\Schema\SqliteSchemaManager;
16
use function strpos;
17
18
/**
19
 * Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for SQLite based drivers.
20
 */
21
abstract class AbstractSQLiteDriver implements Driver, ExceptionConverterDriver
22
{
23
    /**
24
     * {@inheritdoc}
25
     *
26
     * @link http://www.sqlite.org/c3ref/c_abort.html
27
     */
28 734
    public function convertException(string $message, DriverExceptionInterface $exception) : DriverException
29
    {
30 734
        if (strpos($exception->getMessage(), 'database is locked') !== false) {
31 292
            return new Exception\LockWaitTimeoutException($message, $exception);
32
        }
33
34 733
        if (strpos($exception->getMessage(), 'must be unique') !== false ||
35 732
            strpos($exception->getMessage(), 'is not unique') !== false ||
36 731
            strpos($exception->getMessage(), 'are not unique') !== false ||
37 733
            strpos($exception->getMessage(), 'UNIQUE constraint failed') !== false
38
        ) {
39 369
            return new Exception\UniqueConstraintViolationException($message, $exception);
40
        }
41
42 730
        if (strpos($exception->getMessage(), 'may not be NULL') !== false ||
43 730
            strpos($exception->getMessage(), 'NOT NULL constraint failed') !== false
44
        ) {
45 492
            return new Exception\NotNullConstraintViolationException($message, $exception);
46
        }
47
48 729
        if (strpos($exception->getMessage(), 'no such table:') !== false) {
49 392
            return new Exception\TableNotFoundException($message, $exception);
50
        }
51
52 728
        if (strpos($exception->getMessage(), 'already exists') !== false) {
53 417
            return new Exception\TableExistsException($message, $exception);
54
        }
55
56 727
        if (strpos($exception->getMessage(), 'has no column named') !== false) {
57 542
            return new Exception\InvalidFieldNameException($message, $exception);
58
        }
59
60 726
        if (strpos($exception->getMessage(), 'ambiguous column name') !== false) {
61 517
            return new Exception\NonUniqueFieldNameException($message, $exception);
62
        }
63
64 725
        if (strpos($exception->getMessage(), 'syntax error') !== false) {
65 722
            return new Exception\SyntaxErrorException($message, $exception);
66
        }
67
68 569
        if (strpos($exception->getMessage(), 'attempt to write a readonly database') !== false) {
69 467
            return new Exception\ReadOnlyException($message, $exception);
70
        }
71
72 568
        if (strpos($exception->getMessage(), 'unable to open database file') !== false) {
73 567
            return new Exception\ConnectionException($message, $exception);
74
        }
75
76 267
        return new DriverException($message, $exception);
77
    }
78
79
    /**
80
     * {@inheritdoc}
81
     */
82 595
    public function getDatabasePlatform() : AbstractPlatform
83
    {
84 595
        return new SqlitePlatform();
85
    }
86 595
87
    /**
88
     * {@inheritdoc}
89
     */
90
    public function getSchemaManager(Connection $conn) : AbstractSchemaManager
91
    {
92 246
        return new SqliteSchemaManager($conn);
93
    }
94
}
95