|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Flugg\Responder; |
|
4
|
|
|
|
|
5
|
|
|
use Flugg\Responder\Contracts\ErrorFactory as ErrorFactoryContract; |
|
6
|
|
|
use Flugg\Responder\Contracts\ErrorMessageResolver; |
|
|
|
|
|
|
7
|
|
|
use Flugg\Responder\Contracts\ErrorSerializer; |
|
8
|
|
|
|
|
9
|
|
|
/** |
|
10
|
|
|
* A factory class responsible for creating error arrays. |
|
11
|
|
|
* |
|
12
|
|
|
* @package flugger/laravel-responder |
|
13
|
|
|
* @author Alexander Tømmerås <[email protected]> |
|
14
|
|
|
* @license The MIT License |
|
15
|
|
|
*/ |
|
16
|
|
|
class ErrorFactory implements ErrorFactoryContract |
|
17
|
|
|
{ |
|
18
|
|
|
/** |
|
19
|
|
|
* A resolver for resolving messages from error codes. |
|
20
|
|
|
* |
|
21
|
|
|
* @var \Flugg\Responder\Contracts\ErrorMessageResolver |
|
22
|
|
|
*/ |
|
23
|
|
|
protected $messageResolver; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* A serializer for formatting errors. |
|
27
|
|
|
* |
|
28
|
|
|
* @var \Flugg\Responder\Contracts\ErrorSerializer |
|
29
|
|
|
*/ |
|
30
|
|
|
protected $serializer; |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* Construct the factory class. |
|
34
|
|
|
* |
|
35
|
|
|
* @param \Flugg\Responder\Contracts\ErrorMessageResolver $messageResolver |
|
36
|
|
|
* @param \Flugg\Responder\Contracts\ErrorSerializer $serializer |
|
37
|
|
|
*/ |
|
38
|
|
|
public function __construct(ErrorMessageResolver $messageResolver, ErrorSerializer $serializer) |
|
39
|
|
|
{ |
|
40
|
|
|
$this->messageResolver = $messageResolver; |
|
41
|
|
|
$this->serializer = $serializer; |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* Make an error array from the given error code and message. |
|
46
|
|
|
* |
|
47
|
|
|
* @param string|null $errorCode |
|
48
|
|
|
* @param string|null $message |
|
49
|
|
|
* @param array|null $data |
|
50
|
|
|
* @return array |
|
51
|
|
|
*/ |
|
52
|
|
|
public function make(string $errorCode = null, string $message = null, array $data = null): array |
|
53
|
|
|
{ |
|
54
|
|
|
if (isset($errorCode) && ! isset($message)) { |
|
55
|
|
|
$message = $this->messageResolver->resolve($errorCode); |
|
56
|
|
|
} |
|
57
|
|
|
|
|
58
|
|
|
return $this->serializer->format($errorCode, $message, $data); |
|
59
|
|
|
} |
|
60
|
|
|
} |
flugger /
laravel-responder
Let’s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let’s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare 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.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/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: