Repository navigation
Expand file tree
/
Copy pathModuleContainer.php
More file actions
244 lines (210 loc) · 7.77 KB
/
Copy pathModuleContainer.php
File metadata and controls
244 lines (210 loc) · 7.77 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<?php
namespace Codeception\Lib;
use Codeception\Configuration;
use Codeception\Exception\ConfigurationException as ConfigurationException;
use Codeception\Exception\ModuleException as ModuleException;
use Codeception\Exception\ModuleConflictException as ModuleConflictException;
use Codeception\Exception\ModuleRequireException;
use Codeception\Lib\Interfaces\ConflictsWithModule;
use Codeception\Lib\Interfaces\DependsOnModule;
use Codeception\Lib\Interfaces\PartedModule;
use Codeception\Module;
use Codeception\Util\Annotation;
class ModuleContainer
{
const MODULE_NAMESPACE = '\\Codeception\\Module\\';
protected $config;
/**
* @var Di
*/
protected $di;
protected $modules = [];
protected $active = [];
protected $actions = [];
public function __construct(Di $di, $config)
{
$this->di = $di;
$this->di->set($this);
$this->config = $config;
}
/**
* @param $moduleName
* @param bool $active
* @throws ConfigurationException
* @return Module
*/
public function create($moduleName, $active = true)
{
$this->active[$moduleName] = $active;
$config = $this->getModuleConfig($moduleName);
// skip config validation on dependent module
if (empty($config) && !$active) {
$config = null;
}
// helper
$hasNamespace = (strpos($moduleName, '\\') !== false);
if ($hasNamespace) {
return $this->instantiate($moduleName, $moduleName, $config);
}
// standard module
$moduleClass = self::MODULE_NAMESPACE . $moduleName;
if (class_exists($moduleClass)) {
return $this->instantiate($moduleName, $moduleClass, $config);
}
// (deprecated) try find module under namespace setting
$namespace = isset($this->config['namespace']) ? $this->config['namespace'] : '';
$moduleClass = $namespace . self::MODULE_NAMESPACE . $moduleName;
if (class_exists($moduleClass)) {
return $this->instantiate($moduleName, $moduleClass, $config);
}
throw new ConfigurationException("Module $moduleName could not be found and loaded");
}
public function hasModule($module)
{
return isset($this->modules[$module]);
}
public function getModule($module)
{
if (!$this->hasModule($module)) {
throw new ModuleException(__CLASS__, "Module $module couldn't be connected");
}
return $this->modules[$module];
}
public function moduleForAction($action)
{
if (!isset($this->actions[$action])) {
return null;
}
return $this->modules[$this->actions[$action]];
}
public function getActions()
{
return $this->actions;
}
public function all()
{
return $this->modules;
}
private function instantiate($name, $class, $config)
{
$module = $this->di->instantiate($class, [$this, $config], false);
$this->modules[$name] = $module;
if (!$this->active[$name]) {
// if module is not active, its actions should not be included into actor class
return $module;
}
if ($module instanceof DependsOnModule) {
$this->injectDependentModule($name, $module);
}
$class = new \ReflectionClass($module);
$methods = $class->getMethods(\ReflectionMethod::IS_PUBLIC);
foreach ($methods as $method) {
$inherit = $class->getStaticPropertyValue('includeInheritedActions');
$only = $class->getStaticPropertyValue('onlyActions');
$exclude = $class->getStaticPropertyValue('excludeActions');
// exclude methods when they are listed as excluded
if (in_array($method->name, $exclude)) {
continue;
}
if (!empty($only)) {
// skip if method is not listed
if (!in_array($method->name, $only)) {
continue;
}
} else {
// skip if method is inherited and inheritActions == false
if (!$inherit && $method->getDeclaringClass() != $class) {
continue;
}
}
// those with underscore at the beginning are considered as hidden
if (strpos($method->name, '_') === 0) {
continue;
}
if ($module instanceof PartedModule && isset($config['part'])) {
if (!$this->moduleActionBelongsToPart($module, $method->name, $config['part'])) {
continue;
}
}
$this->actions[$method->name] = $name;
}
return $module;
}
public function injectDependentModule($name, DependsOnModule $module)
{
$message = '';
$dependency = $module->_depends();
if (empty($dependency)) {
return;
}
if (is_array($dependency)) {
$message = reset($dependency);
$dependency = key($dependency);
}
$config = $this->getModuleConfig($name);
if (!isset($config['depends'])) {
throw new ModuleRequireException($module,
"\nThis module depends on $dependency\n" .
"\n \n$message");
}
$dependentModule = $this->create($config['depends'], false);
if (!method_exists($module, '_inject')) {
throw new ModuleException($module, 'Module requires method _inject to be defined to accept dependencies');
}
$module->_inject($dependentModule);
$dependentModule->_setConfig([]);
}
public function validateConflicts()
{
$moduleNames = array_keys($this->modules);
for ($i = 0; $i < count($this->modules); $i++) {
/** @var $currentModule Module **/
$currentModule = $this->modules[$moduleNames[$i]];
if (!$currentModule instanceof ConflictsWithModule) {
continue;
}
for ($j = $i; $j < count($this->modules); $j++) {
$inspectedModule = $this->modules[$moduleNames[$j]];
$nameAndInterfaces = array_merge([get_class($inspectedModule), $inspectedModule->_getName()], class_implements($inspectedModule));
if (in_array(ltrim($currentModule->_conflicts(), '\\'), $nameAndInterfaces)) {
throw new ModuleConflictException($currentModule, $inspectedModule);
}
}
}
}
protected function moduleActionBelongsToPart($module, $action, $part)
{
if (!is_array($part)) {
$part = [strtolower($part)];
}
$part = array_map('strtolower', $part);
$parts = Annotation::forMethod($module, $action)->fetchAll('part');
$usedParts = array_intersect($parts, $part);
return !empty($usedParts);
}
protected function getModuleConfig($module)
{
// get config for all modules
$config = isset($this->config['modules']['config'][$module])
? $this->config['modules']['config'][$module]
: [];
if (!isset($this->config['modules']['enabled'])) {
return $config;
}
if (!is_array($this->config['modules']['enabled'])) {
return $config;
}
// get config for enabled modules
foreach ($this->config['modules']['enabled'] as $enabledModuleConfig) {
if (!is_array($enabledModuleConfig)) {
continue;
}
$enabledModuleName = key($enabledModuleConfig);
if ($enabledModuleName !== $module) {
continue;
}
$config = Configuration::mergeConfigs(reset($enabledModuleConfig), $config);
}
return $config;
}
}