[Sommaire] [Imprimer]

   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos -->
   6              <title>Docs For Class TParameterModule</title>
   7              <link rel="stylesheet" href="../media/stylesheet.css" />
   8              <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9          </head>
  10          <body>
  11              <div class="page-body">            
  12  <h2 class="class-name">Class TParameterModule</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                                                              <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                                              <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  22                          
  23              </div>
  24      <div class="info-box-body">
  25                  <!-- ========== Info from phpDoc block ========= -->
  26  <p class="short-description">TParameterModule class</p>
  27  <p class="description"><p>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 <a href="../System.Util/TParameterModule.html#methodsetParameterFile">ParameterFile</a> 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,  <pre><ol><code><pre><li> &lt;<span class="src-id">parameters</span>&gt;</li>
  28  <li>   &lt;<span class="src-id">parameter id</span>=<span class="src-str">&quot;param1&quot; </span><span class="src-id">value</span>=<span class="src-str">&quot;paramValue1&quot; </span>/&gt;</li>
  29  <li>   &lt;<span class="src-id">parameter id</span>=<span class="src-str">&quot;param2&quot; </span><span class="src-id">Property1</span>=<span class="src-str">&quot;Value1&quot; </span><span class="src-id">Property2</span>=<span class="src-str">&quot;Value2&quot; </span>... /&gt;</li>
  30  <li> &lt;/<span class="src-id">parameters</span>&gt;</li>
  31  </pre></code></ol></pre></p><p>In addition, any content enclosed within the module tag is also treated  as parameters, e.g.,  <pre><ol><code><pre><li> &lt;<span class="src-id">module </span><span class="src-key">class</span>=<span class="src-str">&quot;System.Util.TParameterModule&quot;</span>&gt;</li>
  32  <li>   &lt;<span class="src-id">parameter id</span>=<span class="src-str">&quot;param1&quot; </span><span class="src-id">value</span>=<span class="src-str">&quot;paramValue1&quot; </span>/&gt;</li>
  33  <li>   &lt;<span class="src-id">parameter id</span>=<span class="src-str">&quot;param2&quot; </span><span class="src-id">Property1</span>=<span class="src-str">&quot;Value1&quot; </span><span class="src-id">Property2</span>=<span class="src-str">&quot;Value2&quot; </span>... /&gt;</li>
  34  <li> &lt;/<span class="src-id">module</span>&gt;</li>
  35  </pre></code></ol></pre></p><p>If a parameter is defined both in the external file and within the module  tag, the former takes precedence.</p></p>
  36      <ul class="tags">
  37                  <li><span class="field">since:</span> 3.0</li>
  38                  <li><span class="field">version:</span> $Id: TParameterModule.php 1397 2006-09-07 07:55:53Z wei $</li>
  39                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  40              </ul>
  41          <p class="notes">
  42              Located in <a class="field" href="_Util_TParameterModule_php.html">/Util/TParameterModule.php</a> (line <span class="field">47</span>)
  43          </p>
  44          
  45                  
  46          <pre><a href="../System/TComponent.html">TComponent</a>
  47     |
  48     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  49        |
  50        --<a href="../System/TModule.html">TModule</a>
  51           |
  52           --TParameterModule</pre>
  53      
  54              </div>
  55  </div>
  56  
  57  
  58      <a name="sec-const-summary"></a>
  59      <div class="info-box">
  60          <div class="info-box-title">Class Constant Summary</span></div>
  61          <div class="nav-bar">
  62              <a href="#sec-description">Description</a> |
  63                          <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  64                                          | 
  65                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  66                              
  67                      </div>
  68          <div class="info-box-body">
  69              <div class="const-summary">
  70                                  <div class="const-title">
  71                      <img src="../media/images/Constant.png" alt=" " />
  72                      <a href="#PARAM_FILE_EXT" title="details" class="const-name">PARAM_FILE_EXT</a> =                     <span class="var-type">'.xml'</span>
  73  
  74                  </div>
  75                              </div>
  76          </div>
  77      </div>
  78  
  79  
  80      <a name="sec-method-summary"></a>
  81      <div class="info-box">
  82          <div class="info-box-title">Method Summary</span></div>
  83          <div class="nav-bar">
  84              <a href="#sec-description">Description</a> |
  85                                                              <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  86                              
  87                                      <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  88          </div>
  89          <div class="info-box-body">            
  90              <div class="method-summary">
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">string</span>
  94                                          <a href="#getParameterFile" title="details" class="method-name">getParameterFile</a>
  95                                          ()
  96                                      </div>
  97                                  
  98                  <div class="method-definition">
  99                                              <span class="method-result">void</span>
 100                                          <a href="#init" title="details" class="method-name">init</a>
 101                                              (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 102                                      </div>
 103                                  
 104                  <div class="method-definition">
 105                                              <span class="method-result">void</span>
 106                                          <a href="#loadParameters" title="details" class="method-name">loadParameters</a>
 107                                              (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$xmlNode</span>)
 108                                      </div>
 109                                  
 110                  <div class="method-definition">
 111                                              <span class="method-result">void</span>
 112                                          <a href="#setParameterFile" title="details" class="method-name">setParameterFile</a>
 113                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 114                                      </div>
 115                              </div>
 116          </div>
 117      </div>        
 118  
 119      
 120      <a name="sec-methods"></a>
 121      <div class="info-box">
 122          <div class="info-box-title">Methods</div>
 123          <div class="nav-bar">
 124              <a href="#sec-description">Description</a> |
 125                                                                          <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
 126                              
 127                                          <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 128                          
 129          </div>
 130          <div class="info-box-body">
 131              <A NAME='method_detail'></A>
 132  <a name="methodgetParameterFile" id="getParameterFile"><!-- --></a>
 133  <div class="oddrow">
 134      
 135      <div class="method-header">
 136          <span class="method-title">getParameterFile</span> (line <span class="line-number">111</span>)
 137      </div> 
 138      
 139      <!-- ========== Info from phpDoc block ========= -->
 140      <ul class="tags">
 141                  <li><span class="field">return:</span> the parameter file path</li>
 142                  <li><span class="field">access:</span> public</li>
 143              </ul>
 144      
 145      <div class="method-signature">
 146          <span class="method-result">string</span>
 147          <span class="method-name">
 148              getParameterFile
 149          </span>
 150                  ()
 151              </div>
 152      
 153          
 154          
 155      </div>
 156  <a name="methodinit" id="init"><!-- --></a>
 157  <div class="evenrow">
 158      
 159      <div class="method-header">
 160          <span class="method-title">init</span> (line <span class="line-number">57</span>)
 161      </div> 
 162      
 163      <!-- ========== Info from phpDoc block ========= -->
 164  <p class="short-description">Initializes the module by loading parameters.</p>
 165      <ul class="tags">
 166                  <li><span class="field">access:</span> public</li>
 167              </ul>
 168      
 169      <div class="method-signature">
 170          <span class="method-result">void</span>
 171          <span class="method-name">
 172              init
 173          </span>
 174                      (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 175              </div>
 176      
 177              <ul class="parameters">
 178                      <li>
 179                  <span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>
 180                  <span class="var-name">$config</span><span class="var-description">: content enclosed within the module tag</span>            </li>
 181                  </ul>
 182          
 183              <hr class="separator" />
 184          <div class="notes">Redefinition of:</div>
 185          <dl>
 186              <dt><a href="../System/TModule.html#methodinit">TModule::init()</a></dt>
 187                          <dd>Initializes the module.</dd>
 188                      </dl>
 189          
 190      </div>
 191  <a name="methodloadParameters" id="loadParameters"><!-- --></a>
 192  <div class="oddrow">
 193      
 194      <div class="method-header">
 195          <span class="method-title">loadParameters</span> (line <span class="line-number">74</span>)
 196      </div> 
 197      
 198      <!-- ========== Info from phpDoc block ========= -->
 199  <p class="short-description">Loads parameters into application.</p>
 200      <ul class="tags">
 201                  <li><span class="field">access:</span> protected</li>
 202                  <li><span class="field">throws:</span> TConfigurationException if the parameter file format is invalid</li>
 203              </ul>
 204      
 205      <div class="method-signature">
 206          <span class="method-result">void</span>
 207          <span class="method-name">
 208              loadParameters
 209          </span>
 210                      (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$xmlNode</span>)
 211              </div>
 212      
 213              <ul class="parameters">
 214                      <li>
 215                  <span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>
 216                  <span class="var-name">$xmlNode</span><span class="var-description">: XML representation of the parameters</span>            </li>
 217                  </ul>
 218          
 219          
 220      </div>
 221  <a name="methodsetParameterFile" id="setParameterFile"><!-- --></a>
 222  <div class="evenrow">
 223      
 224      <div class="method-header">
 225          <span class="method-title">setParameterFile</span> (line <span class="line-number">122</span>)
 226      </div> 
 227      
 228      <!-- ========== Info from phpDoc block ========= -->
 229      <ul class="tags">
 230                  <li><span class="field">access:</span> public</li>
 231                  <li><span class="field">throws:</span> TInvalidOperationException if the module is initialized</li>
 232                  <li><span class="field">throws:</span> TConfigurationException if the file is invalid</li>
 233              </ul>
 234      
 235      <div class="method-signature">
 236          <span class="method-result">void</span>
 237          <span class="method-name">
 238              setParameterFile
 239          </span>
 240                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 241              </div>
 242      
 243              <ul class="parameters">
 244                      <li>
 245                  <span class="var-type">string</span>
 246                  <span class="var-name">$value</span><span class="var-description">: the parameter file path. It must be in namespace format  and the file extension is '.xml'.</span>            </li>
 247                  </ul>
 248          
 249          
 250      </div>
 251                              <h4>Inherited Methods</h4>
 252                  <a name='inherited_methods'><!-- --></a>    
 253                                      <!-- =========== Summary =========== -->
 254                      <p>Inherited From <span class="classname"><a href="../System/TModule.html">TModule</a></span></p>
 255                      <blockquote>
 256                                                      <span class="method-name"><a href="../System/TModule.html#methodgetID">TModule::getID()</a></span><br>
 257                                                      <span class="method-name"><a href="../System/TModule.html#methodinit">TModule::init()</a></span><br>
 258                                                      <span class="method-name"><a href="../System/TModule.html#methodsetID">TModule::setID()</a></span><br>
 259                                              </blockquote>
 260                                      <!-- =========== Summary =========== -->
 261                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 262                      <blockquote>
 263                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 264                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 265                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 266                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 267                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 268                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 269                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 270                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 271                                              </blockquote>
 272                                      <!-- =========== Summary =========== -->
 273                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 274                      <blockquote>
 275                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 276                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 277                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 278                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 279                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 280                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 281                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 282                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 283                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 284                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 285                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 286                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 287                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 288                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 289                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 290                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 291                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 292                                              </blockquote>
 293                                          
 294          </div>
 295      </div>
 296  
 297      <a name="sec-consts"></a>
 298      <div class="info-box">
 299          <div class="info-box-title">Class Constants</div>
 300          <div class="nav-bar">
 301              <a href="#sec-description">Description</a> |
 302                                          <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
 303                          
 304              
 305                                          | 
 306                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 307                              
 308                      </div>
 309          <div class="info-box-body">
 310              <a name="constPARAM_FILE_EXT" id="PARAM_FILE_EXT"><!-- --></A>
 311  <div class="oddrow">
 312  
 313      <div class="const-header">
 314          <img src="../media/images/Variable.png" />
 315          <span class="const-title">
 316              <span class="const-name">PARAM_FILE_EXT</span>
 317               = <span class="const-default">'.xml'</span>
 318              (line <span class="line-number">49</span>)
 319          </span>
 320      </div>
 321  
 322      <!-- ========== Info from phpDoc block ========= -->
 323      
 324      
 325  </div>
 326  
                        
 327          </div>
 328      </div>
 329  
 330      <p class="notes" id="credit">
 331          Documentation generated on Mon, 04 Dec 2006 11:27:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 332      </p>
 333      </div></body>
 334  </html>