Extension.php
3.2 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
<?php
namespace Codeception;
use Codeception\Configuration as Config;
use Codeception\Event\SuiteEvent;
use Codeception\Exception\ModuleRequireException;
use Codeception\Lib\Console\Output;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
/**
* A base class for all Codeception Extensions and GroupObjects
*
* Available Properties:
*
* * config: current extension configuration
* * options: passed running options
*
*/
abstract class Extension implements EventSubscriberInterface
{
protected $config = [];
protected $options;
protected $output;
protected $globalConfig;
private $modules = [];
public function __construct($config, $options)
{
$this->config = array_merge($this->config, $config);
$this->options = $options;
$this->output = new Output($options);
$this->_initialize();
}
public static function getSubscribedEvents()
{
if (!isset(static::$events)) {
return [Events::SUITE_INIT => 'receiveModuleContainer'];
}
if (isset(static::$events[Events::SUITE_INIT])) {
if (!is_array(static::$events[Events::SUITE_INIT])) {
static::$events[Events::SUITE_INIT] = [[static::$events[Events::SUITE_INIT]]];
}
static::$events[Events::SUITE_INIT][] = ['receiveModuleContainer'];
} else {
static::$events[Events::SUITE_INIT] = 'receiveModuleContainer';
}
return static::$events;
}
public function receiveModuleContainer(SuiteEvent $e)
{
$this->modules = $e->getSuite()->getModules();
}
/**
* Pass config variables that should be injected into global config.
*
* @param array $config
*/
public function _reconfigure($config = [])
{
if (is_array($config)) {
Config::append($config);
}
}
/**
* You can do all preperations here. No need to override constructor.
* Also you can skip calling `_reconfigure` if you don't need to.
*/
public function _initialize()
{
$this->_reconfigure(); // hook for BC only.
}
protected function write($message)
{
if (!$this->options['silent']) {
$this->output->write($message);
}
}
protected function writeln($message)
{
if (!$this->options['silent']) {
$this->output->writeln($message);
}
}
public function hasModule($name)
{
return isset($this->modules[$name]);
}
public function getCurrentModuleNames()
{
return array_keys($this->modules);
}
public function getModule($name)
{
if (!$this->hasModule($name)) {
throw new ModuleRequireException($name, "module is not enabled");
}
return $this->modules[$name];
}
public function getTestsDir()
{
return Config::testsDir();
}
public function getLogDir()
{
return Config::outputDir();
}
public function getDataDir()
{
return Config::dataDir();
}
public function getRootDir()
{
return Config::projectDir();
}
public function getGlobalConfig()
{
return Config::config();
}
}