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
<?php
/**
* @see https://github.com/laminas/laminas-development-mode for the canonical source repository
* @copyright https://github.com/laminas/laminas-development-mode/blob/master/COPYRIGHT.md
* @license https://github.com/laminas/laminas-development-mode/blob/master/LICENSE.md New BSD License
*/
namespace Laminas\DevelopmentMode;
use RuntimeException;
/**
* Shared functionality for the Disable/Enable commands.
*/
trait ConfigDiscoveryTrait
{
/**
* @var null|array
*/
private $applicationConfig;
/**
* @var string
*/
private $applicationConfigPath = 'config/application.config.php';
/**
* @var string
*/
private $mezzioConfigPath = 'config/config.php';
/**
* @var string Base name for configuration cache.
*/
private $configCacheBase = 'module-config-cache';
/**
* Removes the application configuration cache file, if present.
*/
private function removeConfigCacheFile()
{
$configCacheFile = $this->getConfigCacheFile();
if (! $configCacheFile || ! file_exists($configCacheFile)) {
return;
}
unlink($configCacheFile);
}
/**
* Retrieve the config cache file, if any.
*
* @return false|string
*/
private function getConfigCacheFile()
{
$config = $this->getApplicationConfig();
if (isset($config['config_cache_path'])) {
return $config['config_cache_path'];
}
$configCacheDir = $this->getConfigCacheDir();
if (! $configCacheDir) {
return false;
}
$path = sprintf('%s/%s.', $configCacheDir, $this->configCacheBase);
$configCacheKey = $this->getConfigCacheKey();
if ($configCacheKey) {
$path .= $configCacheKey . '.';
}
return $path . 'php';
}
/**
* Return the configured configuration cache directory, if any.
*
* @return null|string
*/
private function getConfigCacheDir()
{
$config = $this->getApplicationConfig();
if (empty($config['module_listener_options']['cache_dir'])) {
return null;
}
return $config['module_listener_options']['cache_dir'];
}
/**
* Return the configured configuration cache key, if any.
*
* @return null|string
*/
private function getConfigCacheKey()
{
$config = $this->getApplicationConfig();
if (empty($config['module_listener_options']['config_cache_key'])) {
return null;
}
return $config['module_listener_options']['config_cache_key'];
}
/**
* Return the application configuration.
*
* Raises an exception if retrieved configuration is not an array.
*
* @return array
* @throws RuntimeException if config/application.config.php does not
* return an array
*/
private function getApplicationConfig()
{
if (null !== $this->applicationConfig) {
return $this->applicationConfig;
}
$configFile = isset($this->projectDir)
? sprintf('%s/%s', $this->projectDir, $this->applicationConfigPath)
: $this->applicationConfigPath;
$configFile = file_exists($configFile) ? $configFile : $this->mezzioConfigPath;
if (! file_exists($configFile)) {
$this->applicationConfig = [];
return $this->applicationConfig;
}
$this->applicationConfig = include $configFile;
if (! is_array($this->applicationConfig)) {
throw new RuntimeException(
'Invalid configuration returned from config/application.config.php or config/config.php;' . PHP_EOL
. 'is this a Laminas or Laminas Mezzio application?' . PHP_EOL
);
}
return $this->applicationConfig;
}
}