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
|
<?php
/**
* TParameterModule class
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2005-2016 The PRADO Group
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Util
*/
/**
* TParameterModule class
*
* TParameterModule enables loading application parameters from external
* storage other than the application configuration.
* To load parameters from an XML file, configure the module by setting
* its {@link setParameterFile ParameterFile} property.
* Note, the property only accepts a file path in namespace format with
* file extension being '.xml'. The file format is as follows, which is
* similar to the parameter portion in an application configuration,
* <code>
* <parameters>
* <parameter id="param1" value="paramValue1" />
* <parameter id="param2" Property1="Value1" Property2="Value2" ... />
* </parameters>
* </code>
*
* In addition, any content enclosed within the module tag is also treated
* as parameters, e.g.,
* <code>
* <module class="System.Util.TParameterModule">
* <parameter id="param1" value="paramValue1" />
* <parameter id="param2" Property1="Value1" Property2="Value2" ... />
* </module>
* </code>
*
* If a parameter is defined both in the external file and within the module
* tag, the former takes precedence.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Carl G. Mathisen <carlgmathisen@gmail.com>
* @package System.Util
* @since 3.0
*/
class TParameterModule extends TModule
{
/**
* @deprecated since 3.2
*/
const PARAM_FILE_EXT='.xml';
private $_initialized=false;
private $_paramFile=null;
/**
* Initializes the module by loading parameters.
* @param mixed content enclosed within the module tag
*/
public function init($config)
{
$this->loadParameters($config);
if($this->_paramFile!==null)
{
$configFile = null;
if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_XML && ($cache=$this->getApplication()->getCache())!==null)
{
$cacheKey='TParameterModule:'.$this->_paramFile;
if(($configFile=$cache->get($cacheKey))===false)
{
$configFile=new TXmlDocument;
$configFile->loadFromFile($this->_paramFile);
$cache->set($cacheKey,$configFile,0,new TFileCacheDependency($this->_paramFile));
}
}
else
{
if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
{
$configFile = include $this->_paramFile;
}
else
{
$configFile=new TXmlDocument;
$configFile->loadFromFile($this->_paramFile);
}
}
$this->loadParameters($configFile);
}
$this->_initialized=true;
}
/**
* Loads parameters into application.
* @param mixed XML of PHP representation of the parameters
* @throws TConfigurationException if the parameter file format is invalid
*/
protected function loadParameters($config)
{
$parameters=array();
if(is_array($config))
{
foreach($config as $id => $parameter)
{
if(is_array($parameter) && isset($parameter['class']))
{
$properties = isset($parameter['properties'])?$parameter['properties']:array();
$parameters[$id]=array($parameter['class'],$properties);
}
else
{
$parameters[$id] = $parameter;
}
}
}
else if($config instanceof TXmlElement)
{
foreach($config->getElementsByTagName('parameter') as $node)
{
$properties=$node->getAttributes();
if(($id=$properties->remove('id'))===null)
throw new TConfigurationException('parametermodule_parameterid_required');
if(($type=$properties->remove('class'))===null)
{
if(($value=$properties->remove('value'))===null)
$parameters[$id]=$node;
else
$parameters[$id]=$value;
}
else
$parameters[$id]=array($type,$properties->toArray());
}
}
$appParams=$this->getApplication()->getParameters();
foreach($parameters as $id=>$parameter)
{
if(is_array($parameter))
{
$component=Prado::createComponent($parameter[0]);
foreach($parameter[1] as $name=>$value)
$component->setSubProperty($name,$value);
$appParams->add($id,$component);
}
else
$appParams->add($id,$parameter);
}
}
/**
* @return string the parameter file path
*/
public function getParameterFile()
{
return $this->_paramFile;
}
/**
* @param string the parameter file path. It must be in namespace format
* and the file extension is '.xml'.
* @throws TInvalidOperationException if the module is initialized
* @throws TConfigurationException if the file is invalid
*/
public function setParameterFile($value)
{
if($this->_initialized)
throw new TInvalidOperationException('parametermodule_parameterfile_unchangeable');
else if(($this->_paramFile=Prado::getPathOfNamespace($value,$this->getApplication()->getConfigurationFileExt()))===null || !is_file($this->_paramFile))
throw new TConfigurationException('parametermodule_parameterfile_invalid',$value);
}
}
|
