-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathErrorHandlerInterface.php
More file actions
97 lines (91 loc) · 2.88 KB
/
ErrorHandlerInterface.php
File metadata and controls
97 lines (91 loc) · 2.88 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?php
declare(strict_types=1);
namespace Dot\ErrorHandler;
use ErrorException;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Throwable;
use Laminas\Stratigility\Exception\MissingResponseException;
use function error_reporting;
use function in_array;
use function restore_error_handler;
use function set_error_handler;
/**
* Error handler middleware.
*
* Use this middleware as the outermost (or close to outermost) middleware
* layer, and use it to intercept PHP errors and exceptions.
*
* The class offers two extension points:
*
* - Error response generators.
* - Listeners.
*
* Error response generators are callables with the following signature:
*
* <code>
* function (
* Throwable $e,
* ServerRequestInterface $request,
* ResponseInterface $response
* ) : ResponseInterface
* </code>
*
* These are provided the error, and the request responsible; the response
* provided is the response prototype provided to the ErrorHandler instance
* itself, and can be used as the basis for returning an error response.
*
* An error response generator must be provided as a constructor argument;
* if not provided, an instance of Laminas\Stratigility\Middleware\ErrorResponseGenerator
* will be used.
*
* Listeners use the following signature:
*
* <code>
* function (
* Throwable $e,
* ServerRequestInterface $request,
* ResponseInterface $response
* ) : void
* </code>
*
* Listeners are given the error, the request responsible, and the generated
* error response, and can then react to them. They are best suited for
* logging and monitoring purposes.
*
* Listeners are attached using the attachListener() method, and triggered
* in the order attached.
*/
interface ErrorHandlerInterface extends MiddlewareInterface
{
/**
* Attach an error listener.
*
* Each listener receives the following three arguments:
*
* - Throwable $error
* - ServerRequestInterface $request
* - ResponseInterface $response
*
* These instances are all immutable, and the return values of
* listeners are ignored; use listeners for reporting purposes
* only.
*/
public function attachListener(callable $listener) : void;
/**
* Middleware to handle errors and exceptions in layers it wraps.
*
* Adds an error handler that will convert PHP errors to ErrorException
* instances.
*
* Internally, wraps the call to $next() in a try/catch block, catching
* all PHP Throwables.
*
* When an exception is caught, an appropriate error response is created
* and returned instead; otherwise, the response returned by $next is
* used.
*/
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface;
}