Issues (201)

src/Driver/ExceptionConverterDriver.php (1 issue)

Labels
Severity
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Doctrine\DBAL\Driver;
6
7
use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
8
use Doctrine\DBAL\Exception\DriverException;
0 ignored issues
show
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...
9
10
/**
11
 * Contract for a driver that is capable of converting DBAL driver exceptions into standardized DBAL driver exceptions.
12
 */
13
interface ExceptionConverterDriver
14
{
15
    /**
16
     * Converts a given DBAL driver exception into a standardized DBAL driver exception.
17
     *
18
     * It evaluates the vendor specific error code and SQLSTATE and transforms
19
     * it into a unified {@link Doctrine\DBAL\Exception\DriverException} subclass.
20
     *
21
     * @param string                   $message   The DBAL exception message to use.
22
     * @param DriverExceptionInterface $exception The DBAL driver exception to convert.
23
     *
24
     * @return DriverException An instance of one of the DriverException subclasses.
25
     */
26
    public function convertException(string $message, DriverExceptionInterface $exception) : DriverException;
27
}
28