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 | * Interface for environment checks |
||
5 | * |
||
6 | * An environment check is a test that can be performed on a live environment. They differ from |
||
7 | * unit tests in that they are designed to check the state of the environment/server, rather than |
||
8 | * the code. |
||
9 | * |
||
10 | * Environment checks should *never* alter production data. |
||
11 | * |
||
12 | * Some things you might make environment checks for: |
||
13 | * - Can I access the database? |
||
14 | * - Are the right PHP modules installed? |
||
15 | * - Are the file permissions correct? |
||
16 | */ |
||
17 | interface EnvironmentCheck { |
||
0 ignored issues
–
show
Coding Style
introduced
by
Loading history...
|
|||
18 | /** |
||
19 | * @var int |
||
20 | */ |
||
21 | const ERROR = 3; |
||
22 | |||
23 | /** |
||
24 | * @var int |
||
25 | */ |
||
26 | const WARNING = 2; |
||
27 | |||
28 | /** |
||
29 | * @var int |
||
30 | */ |
||
31 | const OK = 1; |
||
32 | |||
33 | /** |
||
34 | * @return array Result with 'status' and 'message' keys. |
||
35 | * |
||
36 | * Status is EnvironmentCheck::ERROR, EnvironmentCheck::WARNING, or EnvironmentCheck::OK. |
||
37 | */ |
||
38 | function check(); |
||
39 | } |