These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | |||
4 | /** |
||
5 | * |
||
6 | * Copyright (c) 2010-2018 Nevraxe inc. & Marc André Audet <[email protected]>. All rights reserved. |
||
7 | * |
||
8 | * Redistribution and use in source and binary forms, with or without modification, are |
||
9 | * permitted provided that the following conditions are met: |
||
10 | * |
||
11 | * 1. Redistributions of source code must retain the above copyright notice, this list of |
||
12 | * conditions and the following disclaimer. |
||
13 | * |
||
14 | * 2. Redistributions in binary form must reproduce the above copyright notice, this list |
||
15 | * of conditions and the following disclaimer in the documentation and/or other materials |
||
16 | * provided with the distribution. |
||
17 | * |
||
18 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
||
19 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
||
20 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||
21 | * DISCLAIMED. IN NO EVENT SHALL NEVRAXE INC. & MARC ANDRÉ AUDET BE LIABLE FOR ANY |
||
22 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
||
23 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||
24 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
||
25 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||
26 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
||
27 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
28 | * |
||
29 | */ |
||
30 | |||
31 | |||
32 | namespace Cervo\Interfaces; |
||
33 | |||
34 | |||
35 | use Cervo\Route; |
||
36 | |||
37 | |||
38 | /** |
||
39 | * Cervo middleware interface. |
||
40 | * |
||
41 | * @author Marc André Audet <[email protected]> |
||
42 | */ |
||
43 | interface MiddlewareInterface |
||
44 | { |
||
45 | /** |
||
46 | * MiddlewareInterface constructor. |
||
47 | * |
||
48 | * @param Route $route |
||
49 | */ |
||
50 | public function __construct(Route $route); |
||
0 ignored issues
–
show
|
|||
51 | |||
52 | /** |
||
53 | * Called when checking against the Middleware in the Router |
||
54 | * Return true to keep the request going |
||
55 | * Return false to stop the Router and return an error |
||
56 | * |
||
57 | * @return bool |
||
58 | */ |
||
59 | public function __invoke() : bool; |
||
60 | } |
||
61 |
For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a
@return
doc comment to communicate to implementors of these methods what they are expected to return.