Passed
Push — master ( 5cce8c...cb0ced )
by Edward
04:53
created

QueryExecutionFailedException   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 27
Duplicated Lines 0 %

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 9
c 1
b 0
f 0
dl 0
loc 27
ccs 11
cts 11
cp 1
rs 10
wmc 4

4 Methods

Rating   Name   Duplication   Size   Complexity  
A getSource() 0 3 1
A getCallbackCode() 0 3 1
A buildMessage() 0 3 1
A __construct() 0 5 1
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 6
    public function __construct(string $source, string $callbackCode, Throwable $previous = null)
18
    {
19 6
        $this->source = $source;
20 6
        $this->callbackCode = $callbackCode;
21 6
        parent::__construct($this->buildMessage(), 0, $previous);
22 6
    }
23
24 6
    private function buildMessage(): string
25
    {
26 6
        return "Failed to execute JSONPath query: {$this->source}\n\n{$this->callbackCode}";
27
    }
28
29 1
    public function getSource(): string
30
    {
31 1
        return $this->source;
32
    }
33
34 1
    public function getCallbackCode(): string
35
    {
36 1
        return $this->callbackCode;
37
    }
38
}
39