Parameters.php
7.25 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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
<?php
/**
* @package Regular Labs Library
* @version 18.2.10140
*
* @author Peter van Westen <info@regularlabs.com>
* @link http://www.regularlabs.com
* @copyright Copyright © 2018 Regular Labs All Rights Reserved
* @license http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL
*/
namespace RegularLabs\Library;
defined('_JEXEC') or die;
jimport('joomla.filesystem.file');
use JComponentHelper;
use JFile;
use JPluginHelper;
/**
* Class Parameters
* @package RegularLabs\Library
*/
class Parameters
{
public static $instance = null;
/**
* @return static instance
*/
public static function getInstance()
{
if (is_null(self::$instance))
{
self::$instance = new static;
}
return self::$instance;
}
/**
* Get a usable parameter object based on the Joomla Registry object
* The object will have all the available parameters with their value (default value if none is set)
*
* @param \Registry $params
* @param string $path
* @param string $default
*
* @return object
*/
public function getParams($params, $path = '', $default = '', $use_cache = true)
{
$cache_id = 'getParams_' . json_encode($params) . '_' . $path . '_' . $default;
if ($use_cache && Cache::has($cache_id))
{
return Cache::get($cache_id);
}
$xml = $this->loadXML($path, $default);
if (empty($params))
{
return Cache::set(
$cache_id,
(object) $xml
);
}
if ( ! is_object($params))
{
$params = json_decode($params);
if (is_null($xml))
{
$xml = (object) [];
}
}
elseif (method_exists($params, 'toObject'))
{
$params = $params->toObject();
}
if ( ! $params)
{
return Cache::set(
$cache_id,
(object) $xml
);
}
if (empty($xml))
{
return Cache::set(
$cache_id,
$params
);
}
foreach ($xml as $key => $val)
{
if (isset($params->{$key}) && $params->{$key} != '')
{
continue;
}
$params->{$key} = $val;
}
return Cache::set(
$cache_id,
$params
);
}
/**
* Get a usable parameter object for the component
*
* @param string $name
* @param \Registry $params
*
* @return object
*/
public function getComponentParams($name, $params = null, $use_cache = true)
{
$name = 'com_' . RegEx::replace('^com_', '', $name);
$cache_id = 'getComponentParams_' . $name . '_' . json_encode($params);
if ($use_cache && Cache::has($cache_id))
{
return Cache::get($cache_id);
}
if (empty($params) && JComponentHelper::isInstalled($name))
{
$params = JComponentHelper::getParams($name);
}
return Cache::set(
$cache_id,
$this->getParams($params, JPATH_ADMINISTRATOR . '/components/' . $name . '/config.xml')
);
}
/**
* Get a usable parameter object for the module
*
* @param string $name
* @param int $admin
* @param \Registry $params
*
* @return object
*/
public function getModuleParams($name, $admin = true, $params = '', $use_cache = true)
{
$name = 'mod_' . RegEx::replace('^mod_', '', $name);
$cache_id = 'getModuleParams_' . $name . '_' . json_encode($params);
if ($use_cache && Cache::has($cache_id))
{
return Cache::get($cache_id);
}
if (empty($params))
{
$params = null;
}
return Cache::set(
$cache_id,
$this->getParams($params, ($admin ? JPATH_ADMINISTRATOR : JPATH_SITE) . '/modules/' . $name . '/' . $name . '.xml')
);
}
/**
* Get a usable parameter object for the plugin
*
* @param string $name
* @param string $type
* @param \Registry $params
*
* @return object
*/
public function getPluginParams($name, $type = 'system', $params = '', $use_cache = true)
{
$cache_id = 'getPluginParams_' . $name . '_' . $type . '_' . json_encode($params);
if ($use_cache && Cache::has($cache_id))
{
return Cache::get($cache_id);
}
if (empty($params))
{
$plugin = JPluginHelper::getPlugin($type, $name);
$params = (is_object($plugin) && isset($plugin->params)) ? $plugin->params : null;
}
return Cache::set(
$cache_id,
$this->getParams($params, JPATH_PLUGINS . '/' . $type . '/' . $name . '/' . $name . '.xml')
);
}
/**
* Returns an object based on the data in a given xml array
*
* @param $xml
*
* @return bool|mixed
*/
public function getObjectFromXml(&$xml, $use_cache = true)
{
$cache_id = 'getObjectFromXml_' . json_encode($xml);
if ($use_cache && Cache::has($cache_id))
{
return Cache::get($cache_id);
}
if ( ! is_array($xml))
{
$xml = [$xml];
}
$object = $this->getObjectFromXmlNode($xml);
return Cache::set(
$cache_id,
$object
);
}
/**
* Returns an array based on the data in a given xml file
*
* @param string $path
* @param string $default
*
* @return array
*/
private function loadXML($path, $default = '', $use_cache = true)
{
$cache_id = 'loadXML_' . $path . '_' . $default;
if ($use_cache && Cache::has($cache_id))
{
return Cache::get($cache_id);
}
if ( ! $path
|| ! JFile::exists($path)
|| ! $file = JFile::read($path)
)
{
return Cache::set(
$cache_id,
[]
);
}
$xml = [];
$xml_parser = xml_parser_create();
xml_parse_into_struct($xml_parser, $file, $fields);
xml_parser_free($xml_parser);
$default = $default ? strtoupper($default) : 'DEFAULT';
foreach ($fields as $field)
{
if ($field['tag'] != 'FIELD'
|| ! isset($field['attributes'])
|| ( ! isset($field['attributes']['DEFAULT']) && ! isset($field['attributes'][$default]))
|| ! isset($field['attributes']['NAME'])
|| $field['attributes']['NAME'] == ''
|| $field['attributes']['NAME'][0] == '@'
|| ! isset($field['attributes']['TYPE'])
|| $field['attributes']['TYPE'] == 'spacer'
)
{
continue;
}
if (isset($field['attributes'][$default]))
{
$field['attributes']['DEFAULT'] = $field['attributes'][$default];
}
if ($field['attributes']['TYPE'] == 'textarea')
{
$field['attributes']['DEFAULT'] = str_replace('<br>', "\n", $field['attributes']['DEFAULT']);
}
$xml[$field['attributes']['NAME']] = $field['attributes']['DEFAULT'];
}
return Cache::set(
$cache_id,
$xml
);
}
/**
* Returns the main attributes key from an xml object
*
* @param $xml
*
* @return mixed
*/
private function getKeyFromXML($xml)
{
if ( ! empty($xml->_attributes) && isset($xml->_attributes['name']))
{
return $xml->_attributes['name'];
}
return $xml->_name;
}
/**
* Returns the value from an xml object / node
*
* @param $xml
*
* @return object
*/
private function getValFromXML($xml)
{
if ( ! empty($xml->_attributes) && isset($xml->_attributes['value']))
{
return $xml->_attributes['value'];
}
if (empty($xml->_children))
{
return $xml->_data;
}
return $this->getObjectFromXmlNode($xml->_children);
}
/**
* Create an object from the given xml node
*
* @param $xml
*
* @return object
*/
private function getObjectFromXmlNode($xml)
{
$object = (object) [];
foreach ($xml as $child)
{
$key = $this->getKeyFromXML($child);
$value = $this->getValFromXML($child);
if ( ! isset($object->{$key}))
{
$object->{$key} = $value;
continue;
}
if ( ! is_array($object->{$key}))
{
$object->{$key} = [$object->{$key}];
}
$object->{$key}[] = $value;
}
return $object;
}
}