1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Weew\Config; |
4
|
|
|
|
5
|
|
|
class EnvironmentDetector implements IEnvironmentDetector { |
6
|
|
|
/** |
7
|
|
|
* @var array |
8
|
|
|
*/ |
9
|
|
|
protected $environmentRules = []; |
10
|
|
|
|
11
|
|
|
/** |
12
|
|
|
* @var array |
13
|
|
|
*/ |
14
|
|
|
protected $ignoreRules = []; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* EnvironmentDetector constructor. |
18
|
|
|
*/ |
19
|
|
|
public function __construct() { |
20
|
|
|
$this->addDefaultEnvironmentRules(); |
21
|
|
|
$this->addDefaultIgnoreRules(); |
22
|
|
|
} |
23
|
|
|
|
24
|
|
|
/** |
25
|
|
|
* @param $string |
26
|
|
|
* |
27
|
|
|
* @return null|string |
28
|
|
|
*/ |
29
|
|
|
public function detectEnvironment($string) { |
30
|
|
|
if ($this->matchIgnoreRules($string)) { |
31
|
|
|
return false; |
|
|
|
|
32
|
|
|
} |
33
|
|
|
|
34
|
|
|
if ($env = $this->matchEnvironmentRules($string)) { |
35
|
|
|
return $env; |
36
|
|
|
} |
37
|
|
|
|
38
|
|
|
return null; |
39
|
|
|
} |
40
|
|
|
|
41
|
|
|
/** |
42
|
|
|
* @param $name |
43
|
|
|
* @param array $abbreviations |
44
|
|
|
*/ |
45
|
|
|
public function addEnvironmentRule($name, array $abbreviations = []) { |
46
|
|
|
$this->environmentRules = $this->addRule($this->environmentRules, $name, $abbreviations); |
47
|
|
|
} |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* @param $name |
51
|
|
|
* @param array $abbreviations |
52
|
|
|
*/ |
53
|
|
|
public function addIgnoreRule($name, array $abbreviations = []) { |
54
|
|
|
$this->ignoreRules = $this->addRule($this->ignoreRules, $name, $abbreviations); |
55
|
|
|
} |
56
|
|
|
|
57
|
|
|
/** |
58
|
|
|
* @param array $rules |
59
|
|
|
* @param $name |
60
|
|
|
* @param array $abbreviations |
61
|
|
|
* |
62
|
|
|
* @return array |
63
|
|
|
*/ |
64
|
|
|
protected function addRule(array $rules, $name, array $abbreviations) { |
65
|
|
|
if (array_get($rules, $name) === null) { |
66
|
|
|
$rules[$name] = []; |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
$patterns = $this->createPatternsForStrings($abbreviations); |
70
|
|
|
|
71
|
|
|
foreach ($patterns as $pattern) { |
72
|
|
|
$rules[$name][] = $pattern; |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
return $rules; |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* @param $string |
80
|
|
|
* |
81
|
|
|
* @return null|string |
82
|
|
|
*/ |
83
|
|
|
protected function matchEnvironmentRules($string) { |
84
|
|
|
return $this->matchRules($this->environmentRules, $string); |
85
|
|
|
} |
86
|
|
|
|
87
|
|
|
/** |
88
|
|
|
* @param $string |
89
|
|
|
* |
90
|
|
|
* @return bool |
91
|
|
|
*/ |
92
|
|
|
protected function matchIgnoreRules($string) { |
93
|
|
|
$match = $this->matchRules($this->ignoreRules, $string); |
94
|
|
|
|
95
|
|
|
return !! $match; |
96
|
|
|
} |
97
|
|
|
|
98
|
|
|
private function matchRules(array $rules, $string) { |
99
|
|
|
foreach ($rules as $name => $patterns) { |
100
|
|
|
foreach ($patterns as $pattern) { |
101
|
|
|
if (preg_match($pattern, $string) === 1) { |
102
|
|
|
return $name; |
103
|
|
|
} |
104
|
|
|
} |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
return null; |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* Register default environment rules. |
112
|
|
|
*/ |
113
|
|
|
protected function addDefaultEnvironmentRules() { |
114
|
|
|
$this->addEnvironmentRule('prod', ['prod', 'production']); |
115
|
|
|
$this->addEnvironmentRule('stage', ['stage']); |
116
|
|
|
$this->addEnvironmentRule('dev', ['dev', 'development']); |
117
|
|
|
$this->addEnvironmentRule('test', ['test']); |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
/** |
121
|
|
|
* Register default ignore rules. |
122
|
|
|
*/ |
123
|
|
|
protected function addDefaultIgnoreRules() { |
124
|
|
|
$this->addIgnoreRule('dist', ['dist', 'ignore']); |
125
|
|
|
} |
126
|
|
|
|
127
|
|
|
/** |
128
|
|
|
* @param array $strings |
129
|
|
|
* |
130
|
|
|
* @return string |
131
|
|
|
*/ |
132
|
|
|
protected function createPatternsForStrings(array $strings) { |
133
|
|
|
$patterns = []; |
134
|
|
|
|
135
|
|
|
foreach ($strings as $string) { |
136
|
|
|
$string = preg_quote($string); |
137
|
|
|
|
138
|
|
|
// dist |
139
|
|
|
$patterns[] = s('#^(%s)$#', $string); |
140
|
|
|
// dist. |
141
|
|
|
$patterns[] = s('#^(%s)[._+:-]+#', $string); |
142
|
|
|
// .dist |
143
|
|
|
$patterns[] = s('#[._+:-]+(%s)$#', $string); |
144
|
|
|
// .dist. |
145
|
|
|
$patterns[] = s('#[._+:-]+(%s)[._+:-]+#', $string); |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
return $patterns; |
149
|
|
|
} |
150
|
|
|
} |
151
|
|
|
|
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.