Repository navigation
Expand file tree
/
Copy pathSetting.php
More file actions
195 lines (164 loc) · 3.79 KB
/
Copy pathSetting.php
File metadata and controls
195 lines (164 loc) · 3.79 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
<?php
namespace Example;
/**
* Get settings file. File should be a PHP file returning an array of key / value pairs. Key is
* the variable to be set in the class to the value provided.
*/
abstract class Setting
{
private string $fileName = 'NOT FOUND';
/**
* @var array<string, mixed>
*/
private array $settings = [];
public function __construct(private string $serverName = '')
{
if ('' == $this->serverName)
{
$this->serverName = $_SERVER['SERVER_NAME'] ?? '';
}
$this->load();
}
/**
* @param array<string, mixed> $args
*/
public function __call(string $name, array $args) : ?string
{
if (! \str_starts_with($name, 'get'))
{
throw new \Exception('Method ' . $name . ' is not defined for ' . static::class);
}
$name = \lcfirst(\substr($name, 3));
return $this->settings[$name] ?? null;
}
/**
* Allows for $object->field syntax
*
* Unset fields will return null
*/
public function __get(string $field) : mixed
{
return $this->settings[$field] ?? null;
}
/**
* Allows for $object->field = $x syntax
*/
public function __set(string $field, mixed $value) : void
{
$this->settings[$field] = $value;
}
/**
* Add fields
*
* @param array<string, mixed> $fields key / value field pairs that will be added to the existing settings
*/
public function addFields(array $fields) : static
{
$this->settings = \array_merge($this->settings, $fields);
return $this;
}
public function empty() : bool
{
return empty($this->settings);
}
/**
* @return array<string, mixed>
*/
public function getFields() : array
{
return $this->settings;
}
public function getLoadedFileName() : string
{
return $this->fileName;
}
public function optional(string $key) : mixed
{
return $this->settings[$key] ?? false;
}
public function save() : bool
{
if (! $this->settings)
{
return false;
}
$parts = \explode('\\', static::class);
$className = \array_pop($parts);
if (! empty($this->serverName))
{
$fileName = $this->getFileName($this->serverName . '/' . $className);
}
else
{
$fileName = $this->getFileName($className);
}
$parts = \explode('/', $fileName);
\array_pop($parts);
$dir = \implode('/', $parts);
if (! \is_dir($dir))
{
\mkdir($dir, recursive: true);
}
\file_put_contents($fileName, "<?php\nreturn " . \var_export($this->settings, true) . ';');
return true;
}
/**
* Set the fields
*
* @param array<string, mixed> $fields key / value field pairs that will now be valid fields
*/
public function setFields(array $fields) : static
{
$this->settings = $fields;
return $this;
}
private function getFileName(string $fileName) : string
{
if (false == \strpos($fileName, '.php'))
{
$fileName .= '.php';
}
return PROJECT_ROOT . '/config/' . $fileName;
}
/**
* Load settings file from config directory in project root. The following is the file search order:
*
* - Server name directory, class base name.
* - If server name file is not found, then defaults to class name in config directory
*/
private function load() : void
{
if ($this->settings)
{
return;
}
$parts = \explode('\\', static::class);
$className = \array_pop($parts);
if (! empty($this->serverName))
{
$this->settings = $this->loadFile($this->serverName . '/' . $className);
if ($this->settings)
{
return;
}
}
$this->settings = $this->loadFile($className);
}
/**
* @return array<string, mixed>
*/
private function loadFile(string $configName) : array
{
$fileName = $this->getFileName($configName);
if (\file_exists($fileName))
{
if (\function_exists('opcache_invalidate'))
{
\opcache_invalidate($fileName, true);
}
$this->fileName = $fileName;
return include $fileName;
}
return [];
}
}