Completed
Push — master ( 56ea51...5cce8c )
by Edward
06:13
created

QueryExecutionFailedException::getSource()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 3
ccs 0
cts 2
cp 0
crap 2
rs 10
1
<?php
2
declare(strict_types=1);
3
4
namespace Remorhaz\JSON\Path\Query\Exception;
5
6
use LogicException;
7
use Remorhaz\JSON\Path\Processor\Exception\ExceptionInterface;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Remorhaz\JSON\Path\Query...tion\ExceptionInterface. 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 Throwable;
9
10
final class QueryExecutionFailedException extends LogicException implements ExceptionInterface
11
{
12
13
    private $source;
14
15
    private $callbackCode;
16
17
    public function __construct(string $source, string $callbackCode, Throwable $previous = null)
18
    {
19
        $this->source = $source;
20
        $this->callbackCode = $callbackCode;
21
        parent::__construct($this->buildMessage(), 0, $previous);
22
    }
23
24
    private function buildMessage(): string
25
    {
26
        return "Failed to execute JSONPath query: {$this->source}\n\n{$this->callbackCode}";
27
    }
28
29
    public function getSource(): string
30
    {
31
        return $this->source;
32
    }
33
34
    public function getCallbackCode(): string
35
    {
36
        return $this->callbackCode;
37
    }
38
}
39