[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 TApplication</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 TApplication</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">TApplication class.</p>
  27  <p class="description"><p>TApplication coordinates modules and services, and serves as a configuration  context for all Prado components.</p><p>TApplication uses a configuration file to specify the settings of  the application, the modules, the services, the parameters, and so on.</p><p>TApplication adopts a modular structure. A TApplication instance is a composition  of multiple modules. A module is an instance of class implementing  <a href="../System/IModule.html">IModule</a> interface. Each module accomplishes certain functionalities  that are shared by all Prado components in an application.  There are default modules and user-defined modules. The latter offers extreme  flexibility of extending TApplication in a plug-and-play fashion.  Modules cooperate with each other to serve a user request by following  a sequence of lifecycles predefined in TApplication.</p><p>TApplication has four modes that can be changed by setting <a href="../System/TApplication.html#methodsetMode">Mode</a>  property (in the application configuration file). <ul><li><strong>Off</strong> mode will prevent the application from serving user requests.</li><li><strong>Debug</strong> mode is mainly used during application development. It ensures
  28     the cache is always up-to-date if caching is enabled. It also allows
  29     exceptions are displayed with rich context information if they occur.</li><li><strong>Normal</strong> mode is mainly used during production stage. Exception information
  30     will only be recorded in system error logs. The cache is ensured to be
  31     up-to-date if it is enabled.</li><li><strong>Performance</strong> mode is similar to <strong>Normal</strong> mode except that it
  32     does not ensure the cache is up-to-date.</li></ul>  TApplication dispatches each user request to a particular service which  finishes the actual work for the request with the aid from the application  modules.</p><p>TApplication maintains a lifecycle with the following stages: <ul><li>[construct] : construction of the application instance</li><li>[initApplication] : load application configuration and instantiate modules and the requested service</li><li>onBeginRequest : this event happens right after application initialization</li><li>onAuthentication : this event happens when authentication is needed for the current request</li><li>onAuthenticationComplete : this event happens right after the authentication is done for the current request</li><li>onAuthorization : this event happens when authorization is needed for the current request</li><li>onAuthorizationComplete : this event happens right after the authorization is done for the current request</li><li>onLoadState : this event happens when application state needs to be loaded</li><li>onLoadStateComplete : this event happens right after the application state is loaded</li><li>onPreRunService : this event happens right before the requested service is to run</li><li>runService : the requested service runs</li><li>onSaveState : this event happens when application needs to save its state</li><li>onSaveStateComplete : this event happens right after the application saves its state</li><li>onPreFlushOutput : this event happens right before the application flushes output to client side.</li><li>flushOutput : the application flushes output to client side.</li><li>onEndRequest : this is the last stage a request is being completed</li><li>[destruct] : destruction of the application instance</li></ul> Modules and services can attach their methods to one or several of the above  events and do appropriate processing when the events are raised. By this way,  the application is able to coordinate the activities of modules and services  in the above order. To terminate an application before the whole lifecycle  completes, call <a href="../System/TApplication.html#methodcompleteRequest">completeRequest</a>.</p><p>Examples: <ul><li>Create and run a Prado application:
  33   <pre><ol><code><pre><li> <span class="src-var">$application</span>=<span class="src-key">new </span><span class="src-id"><a href="../System/TApplication.html">TApplication</a></span><span class="src-sym">(</span><span class="src-var">$configFile</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
  34  <li> <span class="src-var">$application</span><span class="src-sym">-&gt;</span><a href="../System/TApplication.html#methodrun">run</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
  35  </pre></code></ol></pre></li></ul></p></p>
  36      <ul class="tags">
  37                  <li><span class="field">since:</span> 3.0</li>
  38                  <li><span class="field">version:</span> $Id: TApplication.php 1559 2006-12-04 03:03:21Z xue $</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="_TApplication_php.html">/TApplication.php</a> (line <span class="field">112</span>)
  43          </p>
  44          
  45                  
  46          <pre><a href="../System/TComponent.html">TComponent</a>
  47     |
  48     --TApplication</pre>
  49      
  50              </div>
  51  </div>
  52  
  53  
  54      <a name="sec-const-summary"></a>
  55      <div class="info-box">
  56          <div class="info-box-title">Class Constant Summary</span></div>
  57          <div class="nav-bar">
  58              <a href="#sec-description">Description</a> |
  59                          <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  60                                          | 
  61                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  62                              
  63                      </div>
  64          <div class="info-box-body">
  65              <div class="const-summary">
  66                                  <div class="const-title">
  67                      <img src="../media/images/Constant.png" alt=" " />
  68                      <a href="#CONFIGCACHE_FILE" title="details" class="const-name">CONFIGCACHE_FILE</a> =                     <span class="var-type">'config.cache'</span>
  69  
  70                  </div>
  71                                  <div class="const-title">
  72                      <img src="../media/images/Constant.png" alt=" " />
  73                      <a href="#CONFIG_FILE" title="details" class="const-name">CONFIG_FILE</a> =                     <span class="var-type">'application.xml'</span>
  74  
  75                  </div>
  76                                  <div class="const-title">
  77                      <img src="../media/images/Constant.png" alt=" " />
  78                      <a href="#GLOBAL_FILE" title="details" class="const-name">GLOBAL_FILE</a> =                     <span class="var-type">'global.cache'</span>
  79  
  80                  </div>
  81                                  <div class="const-title">
  82                      <img src="../media/images/Constant.png" alt=" " />
  83                      <a href="#PAGE_SERVICE_ID" title="details" class="const-name">PAGE_SERVICE_ID</a> =                     <span class="var-type">'page'</span>
  84  
  85                  </div>
  86                                  <div class="const-title">
  87                      <img src="../media/images/Constant.png" alt=" " />
  88                      <a href="#RUNTIME_PATH" title="details" class="const-name">RUNTIME_PATH</a> =                     <span class="var-type">'runtime'</span>
  89  
  90                  </div>
  91                                  <div class="const-title">
  92                      <img src="../media/images/Constant.png" alt=" " />
  93                      <a href="#STATE_DEBUG" title="details" class="const-name">STATE_DEBUG</a> =                     <span class="var-type">'Debug'</span>
  94  
  95                  </div>
  96                                  <div class="const-title">
  97                      <img src="../media/images/Constant.png" alt=" " />
  98                      <a href="#STATE_NORMAL" title="details" class="const-name">STATE_NORMAL</a> =                     <span class="var-type">'Normal'</span>
  99  
 100                  </div>
 101                                  <div class="const-title">
 102                      <img src="../media/images/Constant.png" alt=" " />
 103                      <a href="#STATE_OFF" title="details" class="const-name">STATE_OFF</a> =                     <span class="var-type">'Off'</span>
 104  
 105                  </div>
 106                                  <div class="const-title">
 107                      <img src="../media/images/Constant.png" alt=" " />
 108                      <a href="#STATE_PERFORMANCE" title="details" class="const-name">STATE_PERFORMANCE</a> =                     <span class="var-type">'Performance'</span>
 109  
 110                  </div>
 111                              </div>
 112          </div>
 113      </div>
 114  
 115  
 116      <a name="sec-method-summary"></a>
 117      <div class="info-box">
 118          <div class="info-box-title">Method Summary</span></div>
 119          <div class="nav-bar">
 120              <a href="#sec-description">Description</a> |
 121                                                              <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
 122                              
 123                                      <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 124          </div>
 125          <div class="info-box-body">            
 126              <div class="method-summary">
 127                                  
 128                  <div class="method-definition">
 129                                              <span class="method-result">TApplication</span>
 130                                          <a href="#__construct" title="details" class="method-name">__construct</a>
 131                                              ([<span class="var-type">string</span>&nbsp;<span class="var-name">$basePath</span> = <span class="var-default">'protected'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cacheConfig</span> = <span class="var-default">true</span>])
 132                                      </div>
 133                                  
 134                  <div class="method-definition">
 135                                              <span class="method-result">void</span>
 136                                          <a href="#clearGlobalState" title="details" class="method-name">clearGlobalState</a>
 137                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
 138                                      </div>
 139                                  
 140                  <div class="method-definition">
 141                                              <span class="method-result">void</span>
 142                                          <a href="#completeRequest" title="details" class="method-name">completeRequest</a>
 143                                          ()
 144                                      </div>
 145                                  
 146                  <div class="method-definition">
 147                                              <span class="method-result">void</span>
 148                                          <a href="#flushOutput" title="details" class="method-name">flushOutput</a>
 149                                          ()
 150                                      </div>
 151                                  
 152                  <div class="method-definition">
 153                                              <span class="method-result"><a href="../System/IStatePersister.html">IStatePersister</a></span>
 154                                          <a href="#getApplicationStatePersister" title="details" class="method-name">getApplicationStatePersister</a>
 155                                          ()
 156                                      </div>
 157                                  
 158                  <div class="method-definition">
 159                                              <span class="method-result"><a href="../System.Web/TAssetManager.html">TAssetManager</a></span>
 160                                          <a href="#getAssetManager" title="details" class="method-name">getAssetManager</a>
 161                                          ()
 162                                      </div>
 163                                  
 164                  <div class="method-definition">
 165                                              <span class="method-result"><a href="../System.Security/TAuthorizationRuleCollection.html">TAuthorizationRuleCollection</a></span>
 166                                          <a href="#getAuthorizationRules" title="details" class="method-name">getAuthorizationRules</a>
 167                                          ()
 168                                      </div>
 169                                  
 170                  <div class="method-definition">
 171                                              <span class="method-result">string</span>
 172                                          <a href="#getBasePath" title="details" class="method-name">getBasePath</a>
 173                                          ()
 174                                      </div>
 175                                  
 176                  <div class="method-definition">
 177                                              <span class="method-result"><a href="../System/ICache.html">ICache</a></span>
 178                                          <a href="#getCache" title="details" class="method-name">getCache</a>
 179                                          ()
 180                                      </div>
 181                                  
 182                  <div class="method-definition">
 183                                              <span class="method-result">string</span>
 184                                          <a href="#getConfigurationFile" title="details" class="method-name">getConfigurationFile</a>
 185                                          ()
 186                                      </div>
 187                                  
 188                  <div class="method-definition">
 189                                              <span class="method-result"><a href="../System.Exceptions/TErrorHandler.html">TErrorHandler</a></span>
 190                                          <a href="#getErrorHandler" title="details" class="method-name">getErrorHandler</a>
 191                                          ()
 192                                      </div>
 193                                  
 194                  <div class="method-definition">
 195                                              <span class="method-result"><a href="../System.I18N/TGlobalization.html">TGlobalization</a></span>
 196                                          <a href="#getGlobalization" title="details" class="method-name">getGlobalization</a>
 197                                              ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$createIfNotExists</span> = <span class="var-default">true</span>])
 198                                      </div>
 199                                  
 200                  <div class="method-definition">
 201                                              <span class="method-result">mixed</span>
 202                                          <a href="#getGlobalState" title="details" class="method-name">getGlobalState</a>
 203                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$defaultValue</span> = <span class="var-default">null</span>])
 204                                      </div>
 205                                  
 206                  <div class="method-definition">
 207                                              <span class="method-result">string</span>
 208                                          <a href="#getID" title="details" class="method-name">getID</a>
 209                                          ()
 210                                      </div>
 211                                  
 212                  <div class="method-definition">
 213                                              <span class="method-result"><a href="../System/TApplicationMode.html">TApplicationMode</a></span>
 214                                          <a href="#getMode" title="details" class="method-name">getMode</a>
 215                                          ()
 216                                      </div>
 217                                  
 218                  <div class="method-definition">
 219                                              <span class="method-result"><a href="../System/IModule.html">IModule</a></span>
 220                                          <a href="#getModule" title="details" class="method-name">getModule</a>
 221                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
 222                                      </div>
 223                                  
 224                  <div class="method-definition">
 225                                              <span class="method-result">array</span>
 226                                          <a href="#getModules" title="details" class="method-name">getModules</a>
 227                                          ()
 228                                      </div>
 229                                  
 230                  <div class="method-definition">
 231                                              <span class="method-result"><a href="../System.Web.Services/TPageService.html">TPageService</a></span>
 232                                          <a href="#getPageService" title="details" class="method-name">getPageService</a>
 233                                          ()
 234                                      </div>
 235                                  
 236                  <div class="method-definition">
 237                                              <span class="method-result"><a href="../System.Collections/TMap.html">TMap</a></span>
 238                                          <a href="#getParameters" title="details" class="method-name">getParameters</a>
 239                                          ()
 240                                      </div>
 241                                  
 242                  <div class="method-definition">
 243                                              <span class="method-result"><a href="../System.Web/THttpRequest.html">THttpRequest</a></span>
 244                                          <a href="#getRequest" title="details" class="method-name">getRequest</a>
 245                                          ()
 246                                      </div>
 247                                  
 248                  <div class="method-definition">
 249                                              <span class="method-result">boolean</span>
 250                                          <a href="#getRequestCompleted" title="details" class="method-name">getRequestCompleted</a>
 251                                          ()
 252                                      </div>
 253                                  
 254                  <div class="method-definition">
 255                                              <span class="method-result"><a href="../System.Web/THttpResponse.html">THttpResponse</a></span>
 256                                          <a href="#getResponse" title="details" class="method-name">getResponse</a>
 257                                          ()
 258                                      </div>
 259                                  
 260                  <div class="method-definition">
 261                                              <span class="method-result">string</span>
 262                                          <a href="#getRuntimePath" title="details" class="method-name">getRuntimePath</a>
 263                                          ()
 264                                      </div>
 265                                  
 266                  <div class="method-definition">
 267                                              <span class="method-result"><a href="../System.Security/TSecurityManager.html">TSecurityManager</a></span>
 268                                          <a href="#getSecurityManager" title="details" class="method-name">getSecurityManager</a>
 269                                          ()
 270                                      </div>
 271                                  
 272                  <div class="method-definition">
 273                                              <span class="method-result"><a href="../System/IService.html">IService</a></span>
 274                                          <a href="#getService" title="details" class="method-name">getService</a>
 275                                          ()
 276                                      </div>
 277                                  
 278                  <div class="method-definition">
 279                                              <span class="method-result"><a href="../System.Web/THttpSession.html">THttpSession</a></span>
 280                                          <a href="#getSession" title="details" class="method-name">getSession</a>
 281                                          ()
 282                                      </div>
 283                                  
 284                  <div class="method-definition">
 285                                              <span class="method-result">string</span>
 286                                          <a href="#getUniqueID" title="details" class="method-name">getUniqueID</a>
 287                                          ()
 288                                      </div>
 289                                  
 290                  <div class="method-definition">
 291                                              <span class="method-result"><a href="../System/IUser.html">IUser</a></span>
 292                                          <a href="#getUser" title="details" class="method-name">getUser</a>
 293                                          ()
 294                                      </div>
 295                                  
 296                  <div class="method-definition">
 297                                              <span class="method-result">void</span>
 298                                          <a href="#initApplication" title="details" class="method-name">initApplication</a>
 299                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">1</span>)
 300                                      </div>
 301                                  
 302                  <div class="method-definition">
 303                                              <span class="method-result">void</span>
 304                                          <a href="#loadGlobals" title="details" class="method-name">loadGlobals</a>
 305                                          ()
 306                                      </div>
 307                                  
 308                  <div class="method-definition">
 309                                              <span class="method-result">void</span>
 310                                          <a href="#onAuthentication" title="details" class="method-name">onAuthentication</a>
 311                                          ()
 312                                      </div>
 313                                  
 314                  <div class="method-definition">
 315                                              <span class="method-result">void</span>
 316                                          <a href="#onAuthenticationComplete" title="details" class="method-name">onAuthenticationComplete</a>
 317                                          ()
 318                                      </div>
 319                                  
 320                  <div class="method-definition">
 321                                              <span class="method-result">void</span>
 322                                          <a href="#onAuthorization" title="details" class="method-name">onAuthorization</a>
 323                                          ()
 324                                      </div>
 325                                  
 326                  <div class="method-definition">
 327                                              <span class="method-result">void</span>
 328                                          <a href="#onAuthorizationComplete" title="details" class="method-name">onAuthorizationComplete</a>
 329                                          ()
 330                                      </div>
 331                                  
 332                  <div class="method-definition">
 333                                              <span class="method-result">void</span>
 334                                          <a href="#onBeginRequest" title="details" class="method-name">onBeginRequest</a>
 335                                          ()
 336                                      </div>
 337                                  
 338                  <div class="method-definition">
 339                                              <span class="method-result">void</span>
 340                                          <a href="#onEndRequest" title="details" class="method-name">onEndRequest</a>
 341                                          ()
 342                                      </div>
 343                                  
 344                  <div class="method-definition">
 345                                              <span class="method-result">void</span>
 346                                          <a href="#onError" title="details" class="method-name">onError</a>
 347                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$param</span>)
 348                                      </div>
 349                                  
 350                  <div class="method-definition">
 351                                              <span class="method-result">void</span>
 352                                          <a href="#onLoadState" title="details" class="method-name">onLoadState</a>
 353                                          ()
 354                                      </div>
 355                                  
 356                  <div class="method-definition">
 357                                              <span class="method-result">void</span>
 358                                          <a href="#onLoadStateComplete" title="details" class="method-name">onLoadStateComplete</a>
 359                                          ()
 360                                      </div>
 361                                  
 362                  <div class="method-definition">
 363                                              <span class="method-result">void</span>
 364                                          <a href="#onPreFlushOutput" title="details" class="method-name">onPreFlushOutput</a>
 365                                          ()
 366                                      </div>
 367                                  
 368                  <div class="method-definition">
 369                                              <span class="method-result">void</span>
 370                                          <a href="#onPreRunService" title="details" class="method-name">onPreRunService</a>
 371                                          ()
 372                                      </div>
 373                                  
 374                  <div class="method-definition">
 375                                              <span class="method-result">void</span>
 376                                          <a href="#onSaveState" title="details" class="method-name">onSaveState</a>
 377                                          ()
 378                                      </div>
 379                                  
 380                  <div class="method-definition">
 381                                              <span class="method-result">void</span>
 382                                          <a href="#onSaveStateComplete" title="details" class="method-name">onSaveStateComplete</a>
 383                                          ()
 384                                      </div>
 385                                  
 386                  <div class="method-definition">
 387                                              <span class="method-result">void</span>
 388                                          <a href="#run" title="details" class="method-name">run</a>
 389                                          ()
 390                                      </div>
 391                                  
 392                  <div class="method-definition">
 393                                              <span class="method-result">void</span>
 394                                          <a href="#runService" title="details" class="method-name">runService</a>
 395                                          ()
 396                                      </div>
 397                                  
 398                  <div class="method-definition">
 399                                              <span class="method-result">void</span>
 400                                          <a href="#saveGlobals" title="details" class="method-name">saveGlobals</a>
 401                                          ()
 402                                      </div>
 403                                  
 404                  <div class="method-definition">
 405                                              <span class="method-result">void</span>
 406                                          <a href="#setApplicationStatePersister" title="details" class="method-name">setApplicationStatePersister</a>
 407                                              (<span class="var-type">IStatePersister</span>&nbsp;<span class="var-name">$persister</span>)
 408                                      </div>
 409                                  
 410                  <div class="method-definition">
 411                                              <span class="method-result">void</span>
 412                                          <a href="#setAssetManager" title="details" class="method-name">setAssetManager</a>
 413                                              (<span class="var-type">TAssetManager</span>&nbsp;<span class="var-name">$value</span>)
 414                                      </div>
 415                                  
 416                  <div class="method-definition">
 417                                              <span class="method-result">void</span>
 418                                          <a href="#setCache" title="details" class="method-name">setCache</a>
 419                                              (<span class="var-type">ICache</span>&nbsp;<span class="var-name">$cache</span>)
 420                                      </div>
 421                                  
 422                  <div class="method-definition">
 423                                              <span class="method-result">void</span>
 424                                          <a href="#setErrorHandler" title="details" class="method-name">setErrorHandler</a>
 425                                              (<span class="var-type">TErrorHandler</span>&nbsp;<span class="var-name">$handler</span>)
 426                                      </div>
 427                                  
 428                  <div class="method-definition">
 429                                              <span class="method-result">void</span>
 430                                          <a href="#setGlobalization" title="details" class="method-name">setGlobalization</a>
 431                                              (<span class="var-type">TGlobalization</span>&nbsp;<span class="var-name">$glob</span>)
 432                                      </div>
 433                                  
 434                  <div class="method-definition">
 435                                              <span class="method-result">void</span>
 436                                          <a href="#setGlobalState" title="details" class="method-name">setGlobalState</a>
 437                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$defaultValue</span> = <span class="var-default">null</span>])
 438                                      </div>
 439                                  
 440                  <div class="method-definition">
 441                                              <span class="method-result">void</span>
 442                                          <a href="#setID" title="details" class="method-name">setID</a>
 443                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 444                                      </div>
 445                                  
 446                  <div class="method-definition">
 447                                              <span class="method-result">void</span>
 448                                          <a href="#setMode" title="details" class="method-name">setMode</a>
 449                                              (<span class="var-type"><a href="../System/TApplicationMode.html">TApplicationMode</a></span>&nbsp;<span class="var-name">$value</span>)
 450                                      </div>
 451                                  
 452                  <div class="method-definition">
 453                                              <span class="method-result">void</span>
 454                                          <a href="#setModule" title="details" class="method-name">setModule</a>
 455                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">IModule</span>&nbsp;<span class="var-name">$module</span>)
 456                                      </div>
 457                                  
 458                  <div class="method-definition">
 459                                              <span class="method-result">void</span>
 460                                          <a href="#setPageService" title="details" class="method-name">setPageService</a>
 461                                              (<span class="var-type">TPageService</span>&nbsp;<span class="var-name">$service</span>)
 462                                      </div>
 463                                  
 464                  <div class="method-definition">
 465                                              <span class="method-result">void</span>
 466                                          <a href="#setRequest" title="details" class="method-name">setRequest</a>
 467                                              (<span class="var-type">THttpRequest</span>&nbsp;<span class="var-name">$request</span>)
 468                                      </div>
 469                                  
 470                  <div class="method-definition">
 471                                              <span class="method-result">void</span>
 472                                          <a href="#setResponse" title="details" class="method-name">setResponse</a>
 473                                              (<span class="var-type">THttpResponse</span>&nbsp;<span class="var-name">$response</span>)
 474                                      </div>
 475                                  
 476                  <div class="method-definition">
 477                                              <span class="method-result">void</span>
 478                                          <a href="#setSecurityManager" title="details" class="method-name">setSecurityManager</a>
 479                                              (<span class="var-type">TSecurityManager</span>&nbsp;<span class="var-name">$sm</span>)
 480                                      </div>
 481                                  
 482                  <div class="method-definition">
 483                                              <span class="method-result">void</span>
 484                                          <a href="#setSession" title="details" class="method-name">setSession</a>
 485                                              (<span class="var-type">THttpSession</span>&nbsp;<span class="var-name">$session</span>)
 486                                      </div>
 487                                  
 488                  <div class="method-definition">
 489                                              <span class="method-result">void</span>
 490                                          <a href="#setUser" title="details" class="method-name">setUser</a>
 491                                              (<span class="var-type">IUser</span>&nbsp;<span class="var-name">$user</span>)
 492                                      </div>
 493                              </div>
 494          </div>
 495      </div>        
 496  
 497      
 498      <a name="sec-methods"></a>
 499      <div class="info-box">
 500          <div class="info-box-title">Methods</div>
 501          <div class="nav-bar">
 502              <a href="#sec-description">Description</a> |
 503                                                                          <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
 504                              
 505                                          <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 506                          
 507          </div>
 508          <div class="info-box-body">
 509              <A NAME='method_detail'></A>
 510  <a name="method__construct" id="__construct"><!-- --></a>
 511  <div class="oddrow">
 512      
 513      <div class="method-header">
 514          <span class="method-title">Constructor __construct</span> (line <span class="line-number">286</span>)
 515      </div> 
 516      
 517      <!-- ========== Info from phpDoc block ========= -->
 518  <p class="short-description">Constructor.</p>
 519  <p class="description"><p>Sets application base path and initializes the application singleton.  Application base path refers to the root directory storing application  data and code not directly accessible by Web users.  By default, the base path is assumed to be the <strong>protected</strong>  directory under the directory containing the current running script.</p></p>
 520      <ul class="tags">
 521                  <li><span class="field">access:</span> public</li>
 522                  <li><span class="field">throws:</span> TConfigurationException if configuration file cannot be read or the runtime path is invalid.</li>
 523              </ul>
 524      
 525      <div class="method-signature">
 526          <span class="method-result">TApplication</span>
 527          <span class="method-name">
 528              __construct
 529          </span>
 530                      ([<span class="var-type">string</span>&nbsp;<span class="var-name">$basePath</span> = <span class="var-default">'protected'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cacheConfig</span> = <span class="var-default">true</span>])
 531              </div>
 532      
 533              <ul class="parameters">
 534                      <li>
 535                  <span class="var-type">string</span>
 536                  <span class="var-name">$basePath</span><span class="var-description">: application base path or configuration file path.         If the parameter is a file, it is assumed to be the application         configuration file, and the directory containing the file is treated         as the application base path.         If it is a directory, it is assumed to be the application base path,         and within that directory, a file named <strong>application.xml</strong>         will be looked for. If found, the file is considered as the application         configuration file.</span>            </li>
 537                      <li>
 538                  <span class="var-type">boolean</span>
 539                  <span class="var-name">$cacheConfig</span><span class="var-description">: whether to cache application configuration. Defaults to true.</span>            </li>
 540                  </ul>
 541          
 542          
 543      </div>
 544  <a name="methodclearGlobalState" id="clearGlobalState"><!-- --></a>
 545  <div class="evenrow">
 546      
 547      <div class="method-header">
 548          <span class="method-title">clearGlobalState</span> (line <span class="line-number">416</span>)
 549      </div> 
 550      
 551      <!-- ========== Info from phpDoc block ========= -->
 552  <p class="short-description">Clears a global value.</p>
 553  <p class="description"><p>The value cleared will no longer be available in this request and the following requests.</p></p>
 554      <ul class="tags">
 555                  <li><span class="field">access:</span> public</li>
 556              </ul>
 557      
 558      <div class="method-signature">
 559          <span class="method-result">void</span>
 560          <span class="method-name">
 561              clearGlobalState
 562          </span>
 563                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
 564              </div>
 565      
 566              <ul class="parameters">
 567                      <li>
 568                  <span class="var-type">string</span>
 569                  <span class="var-name">$key</span><span class="var-description">: the name of the value to be cleared</span>            </li>
 570                  </ul>
 571          
 572          
 573      </div>
 574  <a name="methodcompleteRequest" id="completeRequest"><!-- --></a>
 575  <div class="oddrow">
 576      
 577      <div class="method-header">
 578          <span class="method-title">completeRequest</span> (line <span class="line-number">366</span>)
 579      </div> 
 580      
 581      <!-- ========== Info from phpDoc block ========= -->
 582  <p class="short-description">Completes current request processing.</p>
 583  <p class="description"><p>This method can be used to exit the application lifecycles after finishing  the current cycle.</p></p>
 584      <ul class="tags">
 585                  <li><span class="field">access:</span> public</li>
 586              </ul>
 587      
 588      <div class="method-signature">
 589          <span class="method-result">void</span>
 590          <span class="method-name">
 591              completeRequest
 592          </span>
 593                  ()
 594              </div>
 595      
 596          
 597          
 598      </div>
 599  <a name="methodflushOutput" id="flushOutput"><!-- --></a>
 600  <div class="evenrow">
 601      
 602      <div class="method-header">
 603          <span class="method-title">flushOutput</span> (line <span class="line-number">1032</span>)
 604      </div> 
 605      
 606      <!-- ========== Info from phpDoc block ========= -->
 607  <p class="short-description">Flushes output to client side.</p>
 608      <ul class="tags">
 609                  <li><span class="field">access:</span> public</li>
 610              </ul>
 611      
 612      <div class="method-signature">
 613          <span class="method-result">void</span>
 614          <span class="method-name">
 615              flushOutput
 616          </span>
 617                  ()
 618              </div>
 619      
 620          
 621          
 622      </div>
 623  <a name="methodgetApplicationStatePersister" id="getApplicationStatePersister"><!-- --></a>
 624  <div class="oddrow">
 625      
 626      <div class="method-header">
 627          <span class="method-title">getApplicationStatePersister</span> (line <span class="line-number">712</span>)
 628      </div> 
 629      
 630      <!-- ========== Info from phpDoc block ========= -->
 631      <ul class="tags">
 632                  <li><span class="field">return:</span> application state persister</li>
 633                  <li><span class="field">access:</span> public</li>
 634              </ul>
 635      
 636      <div class="method-signature">
 637          <span class="method-result"><a href="../System/IStatePersister.html">IStatePersister</a></span>
 638          <span class="method-name">
 639              getApplicationStatePersister
 640          </span>
 641                  ()
 642              </div>
 643      
 644          
 645          
 646      </div>
 647  <a name="methodgetAssetManager" id="getAssetManager"><!-- --></a>
 648  <div class="evenrow">
 649      
 650      <div class="method-header">
 651          <span class="method-title">getAssetManager</span> (line <span class="line-number">691</span>)
 652      </div> 
 653      
 654      <!-- ========== Info from phpDoc block ========= -->
 655      <ul class="tags">
 656                  <li><span class="field">return:</span> asset manager</li>
 657                  <li><span class="field">access:</span> public</li>
 658              </ul>
 659      
 660      <div class="method-signature">
 661          <span class="method-result"><a href="../System.Web/TAssetManager.html">TAssetManager</a></span>
 662          <span class="method-name">
 663              getAssetManager
 664          </span>
 665                  ()
 666              </div>
 667      
 668          
 669          
 670      </div>
 671  <a name="methodgetAuthorizationRules" id="getAuthorizationRules"><!-- --></a>
 672  <div class="oddrow">
 673      
 674      <div class="method-header">
 675          <span class="method-title">getAuthorizationRules</span> (line <span class="line-number">784</span>)
 676      </div> 
 677      
 678      <!-- ========== Info from phpDoc block ========= -->
 679      <ul class="tags">
 680                  <li><span class="field">return:</span> list of authorization rules for the current request</li>
 681                  <li><span class="field">access:</span> public</li>
 682              </ul>
 683      
 684      <div class="method-signature">
 685          <span class="method-result"><a href="../System.Security/TAuthorizationRuleCollection.html">TAuthorizationRuleCollection</a></span>
 686          <span class="method-name">
 687              getAuthorizationRules
 688          </span>
 689                  ()
 690              </div>
 691      
 692          
 693          
 694      </div>
 695  <a name="methodgetBasePath" id="getBasePath"><!-- --></a>
 696  <div class="evenrow">
 697      
 698      <div class="method-header">
 699          <span class="method-title">getBasePath</span> (line <span class="line-number">489</span>)
 700      </div> 
 701      
 702      <!-- ========== Info from phpDoc block ========= -->
 703      <ul class="tags">
 704                  <li><span class="field">return:</span> configuration path</li>
 705                  <li><span class="field">access:</span> public</li>
 706              </ul>
 707      
 708      <div class="method-signature">
 709          <span class="method-result">string</span>
 710          <span class="method-name">
 711              getBasePath
 712          </span>
 713                  ()
 714              </div>
 715      
 716          
 717          
 718      </div>
 719  <a name="methodgetCache" id="getCache"><!-- --></a>
 720  <div class="oddrow">
 721      
 722      <div class="method-header">
 723          <span class="method-title">getCache</span> (line <span class="line-number">733</span>)
 724      </div> 
 725      
 726      <!-- ========== Info from phpDoc block ========= -->
 727      <ul class="tags">
 728                  <li><span class="field">return:</span> the cache module, null if cache module is not installed</li>
 729                  <li><span class="field">access:</span> public</li>
 730              </ul>
 731      
 732      <div class="method-signature">
 733          <span class="method-result"><a href="../System/ICache.html">ICache</a></span>
 734          <span class="method-name">
 735              getCache
 736          </span>
 737                  ()
 738              </div>
 739      
 740          
 741          
 742      </div>
 743  <a name="methodgetConfigurationFile" id="getConfigurationFile"><!-- --></a>
 744  <div class="evenrow">
 745      
 746      <div class="method-header">
 747          <span class="method-title">getConfigurationFile</span> (line <span class="line-number">497</span>)
 748      </div> 
 749      
 750      <!-- ========== Info from phpDoc block ========= -->
 751      <ul class="tags">
 752                  <li><span class="field">return:</span> configuration file path</li>
 753                  <li><span class="field">access:</span> public</li>
 754              </ul>
 755      
 756      <div class="method-signature">
 757          <span class="method-result">string</span>
 758          <span class="method-name">
 759              getConfigurationFile
 760          </span>
 761                  ()
 762              </div>
 763      
 764          
 765          
 766      </div>
 767  <a name="methodgetErrorHandler" id="getErrorHandler"><!-- --></a>
 768  <div class="oddrow">
 769      
 770      <div class="method-header">
 771          <span class="method-title">getErrorHandler</span> (line <span class="line-number">649</span>)
 772      </div> 
 773      
 774      <!-- ========== Info from phpDoc block ========= -->
 775      <ul class="tags">
 776                  <li><span class="field">return:</span> the error hanlder module</li>
 777                  <li><span class="field">access:</span> public</li>
 778              </ul>
 779      
 780      <div class="method-signature">
 781          <span class="method-result"><a href="../System.Exceptions/TErrorHandler.html">TErrorHandler</a></span>
 782          <span class="method-name">
 783              getErrorHandler
 784          </span>
 785                  ()
 786              </div>
 787      
 788          
 789          
 790      </div>
 791  <a name="methodgetGlobalization" id="getGlobalization"><!-- --></a>
 792  <div class="evenrow">
 793      
 794      <div class="method-header">
 795          <span class="method-title">getGlobalization</span> (line <span class="line-number">766</span>)
 796      </div> 
 797      
 798      <!-- ========== Info from phpDoc block ========= -->
 799      <ul class="tags">
 800                  <li><span class="field">return:</span> globalization module</li>
 801                  <li><span class="field">access:</span> public</li>
 802              </ul>
 803      
 804      <div class="method-signature">
 805          <span class="method-result"><a href="../System.I18N/TGlobalization.html">TGlobalization</a></span>
 806          <span class="method-name">
 807              getGlobalization
 808          </span>
 809                      ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$createIfNotExists</span> = <span class="var-default">true</span>])
 810              </div>
 811      
 812              <ul class="parameters">
 813                      <li>
 814                  <span class="var-type">boolean</span>
 815                  <span class="var-name">$createIfNotExists</span><span class="var-description">: whether to create globalization if it does not exist</span>            </li>
 816                  </ul>
 817          
 818          
 819      </div>
 820  <a name="methodgetGlobalState" id="getGlobalState"><!-- --></a>
 821  <div class="oddrow">
 822      
 823      <div class="method-header">
 824          <span class="method-title">getGlobalState</span> (line <span class="line-number">387</span>)
 825      </div> 
 826      
 827      <!-- ========== Info from phpDoc block ========= -->
 828  <p class="short-description">Returns a global value.</p>
 829  <p class="description"><p>A global value is one that is persistent across users sessions and requests.</p></p>
 830      <ul class="tags">
 831                  <li><span class="field">return:</span> the global value corresponding to $key</li>
 832                  <li><span class="field">access:</span> public</li>
 833              </ul>
 834      
 835      <div class="method-signature">
 836          <span class="method-result">mixed</span>
 837          <span class="method-name">
 838              getGlobalState
 839          </span>
 840                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$defaultValue</span> = <span class="var-default">null</span>])
 841              </div>
 842      
 843              <ul class="parameters">
 844                      <li>
 845                  <span class="var-type">string</span>
 846                  <span class="var-name">$key</span><span class="var-description">: the name of the value to be returned</span>            </li>
 847                      <li>
 848                  <span class="var-type">mixed</span>
 849                  <span class="var-name">$defaultValue</span><span class="var-description">: the default value. If $key is not found, $defaultValue will be returned</span>            </li>
 850                  </ul>
 851          
 852          
 853      </div>
 854  <a name="methodgetID" id="getID"><!-- --></a>
 855  <div class="evenrow">
 856      
 857      <div class="method-header">
 858          <span class="method-title">getID</span> (line <span class="line-number">449</span>)
 859      </div> 
 860      
 861      <!-- ========== Info from phpDoc block ========= -->
 862      <ul class="tags">
 863                  <li><span class="field">return:</span> application ID</li>
 864                  <li><span class="field">access:</span> public</li>
 865              </ul>
 866      
 867      <div class="method-signature">
 868          <span class="method-result">string</span>
 869          <span class="method-name">
 870              getID
 871          </span>
 872                  ()
 873              </div>
 874      
 875          
 876          
 877      </div>
 878  <a name="methodgetMode" id="getMode"><!-- --></a>
 879  <div class="oddrow">
 880      
 881      <div class="method-header">
 882          <span class="method-title">getMode</span> (line <span class="line-number">473</span>)
 883      </div> 
 884      
 885      <!-- ========== Info from phpDoc block ========= -->
 886      <ul class="tags">
 887                  <li><span class="field">return:</span> application mode. Defaults to TApplicationMode::Debug.</li>
 888                  <li><span class="field">access:</span> public</li>
 889              </ul>
 890      
 891      <div class="method-signature">
 892          <span class="method-result"><a href="../System/TApplicationMode.html">TApplicationMode</a></span>
 893          <span class="method-name">
 894              getMode
 895          </span>
 896                  ()
 897              </div>
 898      
 899          
 900          
 901      </div>
 902  <a name="methodgetModule" id="getModule"><!-- --></a>
 903  <div class="evenrow">
 904      
 905      <div class="method-header">
 906          <span class="method-title">getModule</span> (line <span class="line-number">536</span>)
 907      </div> 
 908      
 909      <!-- ========== Info from phpDoc block ========= -->
 910      <ul class="tags">
 911                  <li><span class="field">return:</span> the module with the specified ID, null if not found</li>
 912                  <li><span class="field">access:</span> public</li>
 913              </ul>
 914      
 915      <div class="method-signature">
 916          <span class="method-result"><a href="../System/IModule.html">IModule</a></span>
 917          <span class="method-name">
 918              getModule
 919          </span>
 920                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
 921              </div>
 922      
 923          
 924          
 925      </div>
 926  <a name="methodgetModules" id="getModules"><!-- --></a>
 927  <div class="oddrow">
 928      
 929      <div class="method-header">
 930          <span class="method-title">getModules</span> (line <span class="line-number">544</span>)
 931      </div> 
 932      
 933      <!-- ========== Info from phpDoc block ========= -->
 934      <ul class="tags">
 935                  <li><span class="field">return:</span> list of loaded application modules, indexed by module IDs</li>
 936                  <li><span class="field">access:</span> public</li>
 937              </ul>
 938      
 939      <div class="method-signature">
 940          <span class="method-result">array</span>
 941          <span class="method-name">
 942              getModules
 943          </span>
 944                  ()
 945              </div>
 946      
 947          
 948          
 949      </div>
 950  <a name="methodgetPageService" id="getPageService"><!-- --></a>
 951  <div class="evenrow">
 952      
 953      <div class="method-header">
 954          <span class="method-title">getPageService</span> (line <span class="line-number">563</span>)
 955      </div> 
 956      
 957      <!-- ========== Info from phpDoc block ========= -->
 958      <ul class="tags">
 959                  <li><span class="field">return:</span> page service</li>
 960                  <li><span class="field">access:</span> public</li>
 961              </ul>
 962      
 963      <div class="method-signature">
 964          <span class="method-result"><a href="../System.Web.Services/TPageService.html">TPageService</a></span>
 965          <span class="method-name">
 966              getPageService
 967          </span>
 968                  ()
 969              </div>
 970      
 971          
 972          
 973      </div>
 974  <a name="methodgetParameters" id="getParameters"><!-- --></a>
 975  <div class="oddrow">
 976      
 977      <div class="method-header">
 978          <span class="method-title">getParameters</span> (line <span class="line-number">555</span>)
 979      </div> 
 980      
 981      <!-- ========== Info from phpDoc block ========= -->
 982  <p class="short-description">Returns the list of application parameters.</p>
 983  <p class="description"><p>Since the parameters are returned as a <a href="../System.Collections/TMap.html">TMap</a> object, you may use  the returned result to access, add or remove individual parameters.</p></p>
 984      <ul class="tags">
 985                  <li><span class="field">return:</span> the list of application parameters</li>
 986                  <li><span class="field">access:</span> public</li>
 987              </ul>
 988      
 989      <div class="method-signature">
 990          <span class="method-result"><a href="../System.Collections/TMap.html">TMap</a></span>
 991          <span class="method-name">
 992              getParameters
 993          </span>
 994                  ()
 995              </div>
 996      
 997          
 998          
 999      </div>
1000  <a name="methodgetRequest" id="getRequest"><!-- --></a>
1001  <div class="evenrow">
1002      
1003      <div class="method-header">
1004          <span class="method-title">getRequest</span> (line <span class="line-number">586</span>)
1005      </div> 
1006      
1007      <!-- ========== Info from phpDoc block ========= -->
1008      <ul class="tags">
1009                  <li><span class="field">return:</span> the request module</li>
1010                  <li><span class="field">access:</span> public</li>
1011              </ul>
1012      
1013      <div class="method-signature">
1014          <span class="method-result"><a href="../System.Web/THttpRequest.html">THttpRequest</a></span>
1015          <span class="method-name">
1016              getRequest
1017          </span>
1018                  ()
1019              </div>
1020      
1021          
1022          
1023      </div>
1024  <a name="methodgetRequestCompleted" id="getRequestCompleted"><!-- --></a>
1025  <div class="oddrow">
1026      
1027      <div class="method-header">
1028          <span class="method-title">getRequestCompleted</span> (line <span class="line-number">374</span>)
1029      </div> 
1030      
1031      <!-- ========== Info from phpDoc block ========= -->
1032      <ul class="tags">
1033                  <li><span class="field">return:</span> whether the current request is processed.</li>
1034                  <li><span class="field">access:</span> public</li>
1035              </ul>
1036      
1037      <div class="method-signature">
1038          <span class="method-result">boolean</span>
1039          <span class="method-name">
1040              getRequestCompleted
1041          </span>
1042                  ()
1043              </div>
1044      
1045          
1046          
1047      </div>
1048  <a name="methodgetResponse" id="getResponse"><!-- --></a>
1049  <div class="evenrow">
1050      
1051      <div class="method-header">
1052          <span class="method-title">getResponse</span> (line <span class="line-number">607</span>)
1053      </div> 
1054      
1055      <!-- ========== Info from phpDoc block ========= -->
1056      <ul class="tags">
1057                  <li><span class="field">return:</span> the response module</li>
1058                  <li><span class="field">access:</span> public</li>
1059              </ul>
1060      
1061      <div class="method-signature">
1062          <span class="method-result"><a href="../System.Web/THttpResponse.html">THttpResponse</a></span>
1063          <span class="method-name">
1064              getResponse
1065          </span>
1066                  ()
1067              </div>
1068      
1069          
1070          
1071      </div>
1072  <a name="methodgetRuntimePath" id="getRuntimePath"><!-- --></a>
1073  <div class="oddrow">
1074      
1075      <div class="method-header">
1076          <span class="method-title">getRuntimePath</span> (line <span class="line-number">506</span>)
1077      </div> 
1078      
1079      <!-- ========== Info from phpDoc block ========= -->
1080  <p class="short-description">Gets the directory storing application-level persistent data.</p>
1081      <ul class="tags">
1082                  <li><span class="field">return:</span> application state path</li>
1083                  <li><span class="field">access:</span> public</li>
1084              </ul>
1085      
1086      <div class="method-signature">
1087          <span class="method-result">string</span>
1088          <span class="method-name">
1089              getRuntimePath
1090          </span>
1091                  ()
1092              </div>
1093      
1094          
1095          
1096      </div>
1097  <a name="methodgetSecurityManager" id="getSecurityManager"><!-- --></a>
1098  <div class="evenrow">
1099      
1100      <div class="method-header">
1101          <span class="method-title">getSecurityManager</span> (line <span class="line-number">670</span>)
1102      </div> 
1103      
1104      <!-- ========== Info from phpDoc block ========= -->
1105      <ul class="tags">
1106                  <li><span class="field">return:</span> the security manager module</li>
1107                  <li><span class="field">access:</span> public</li>
1108              </ul>
1109      
1110      <div class="method-signature">
1111          <span class="method-result"><a href="../System.Security/TSecurityManager.html">TSecurityManager</a></span>
1112          <span class="method-name">
1113              getSecurityManager
1114          </span>
1115                  ()
1116              </div>
1117      
1118          
1119          
1120      </div>
1121  <a name="methodgetService" id="getService"><!-- --></a>
1122  <div class="oddrow">
1123      
1124      <div class="method-header">
1125          <span class="method-title">getService</span> (line <span class="line-number">514</span>)
1126      </div> 
1127      
1128      <!-- ========== Info from phpDoc block ========= -->
1129      <ul class="tags">
1130                  <li><span class="field">return:</span> the currently requested service</li>
1131                  <li><span class="field">access:</span> public</li>
1132              </ul>
1133      
1134      <div class="method-signature">
1135          <span class="method-result"><a href="../System/IService.html">IService</a></span>
1136          <span class="method-name">
1137              getService
1138          </span>
1139                  ()
1140              </div>
1141      
1142          
1143          
1144      </div>
1145  <a name="methodgetSession" id="getSession"><!-- --></a>
1146  <div class="evenrow">
1147      
1148      <div class="method-header">
1149          <span class="method-title">getSession</span> (line <span class="line-number">628</span>)
1150      </div> 
1151      
1152      <!-- ========== Info from phpDoc block ========= -->
1153      <ul class="tags">
1154                  <li><span class="field">return:</span> the session module, null if session module is not installed</li>
1155                  <li><span class="field">access:</span> public</li>
1156              </ul>
1157      
1158      <div class="method-signature">
1159          <span class="method-result"><a href="../System.Web/THttpSession.html">THttpSession</a></span>
1160          <span class="method-name">
1161              getSession
1162          </span>
1163                  ()
1164              </div>
1165      
1166          
1167          
1168      </div>
1169  <a name="methodgetUniqueID" id="getUniqueID"><!-- --></a>
1170  <div class="oddrow">
1171      
1172      <div class="method-header">
1173          <span class="method-title">getUniqueID</span> (line <span class="line-number">465</span>)
1174      </div> 
1175      
1176      <!-- ========== Info from phpDoc block ========= -->
1177      <ul class="tags">
1178                  <li><span class="field">return:</span> an ID that uniquely identifies this Prado application from the others</li>
1179                  <li><span class="field">access:</span> public</li>
1180              </ul>
1181      
1182      <div class="method-signature">
1183          <span class="method-result">string</span>
1184          <span class="method-name">
1185              getUniqueID
1186          </span>
1187                  ()
1188              </div>
1189      
1190          
1191          
1192      </div>
1193  <a name="methodgetUser" id="getUser"><!-- --></a>
1194  <div class="evenrow">
1195      
1196      <div class="method-header">
1197          <span class="method-title">getUser</span> (line <span class="line-number">749</span>)
1198      </div> 
1199      
1200      <!-- ========== Info from phpDoc block ========= -->
1201      <ul class="tags">
1202                  <li><span class="field">return:</span> the application user</li>
1203                  <li><span class="field">access:</span> public</li>
1204              </ul>
1205      
1206      <div class="method-signature">
1207          <span class="method-result"><a href="../System/IUser.html">IUser</a></span>
1208          <span class="method-name">
1209              getUser
1210          </span>
1211                  ()
1212              </div>
1213      
1214          
1215          
1216      </div>
1217  <a name="methodinitApplication" id="initApplication"><!-- --></a>
1218  <div class="oddrow">
1219      
1220      <div class="method-header">
1221          <span class="method-title">initApplication</span> (line <span class="line-number">800</span>)
1222      </div> 
1223      
1224      <!-- ========== Info from phpDoc block ========= -->
1225  <p class="short-description">Loads configuration and initializes application.</p>
1226  <p class="description"><p>Configuration file will be read and parsed (if a valid cached version exists,  it will be used instead). Then, modules are created and initialized;  Afterwards, the requested service is created and initialized.</p></p>
1227      <ul class="tags">
1228                  <li><span class="field">access:</span> protected</li>
1229                  <li><span class="field">throws:</span> TConfigurationException if module is redefined of invalid type, or service not defined or of invalid type</li>
1230              </ul>
1231      
1232      <div class="method-signature">
1233          <span class="method-result">void</span>
1234          <span class="method-name">
1235              initApplication
1236          </span>
1237                      (<span class="var-type">string</span>&nbsp;<span class="var-name">0</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">1</span>)
1238              </div>
1239      
1240              <ul class="parameters">
1241                      <li>
1242                  <span class="var-type">string</span>
1243                  <span class="var-name">0</span><span class="var-description">: configuration file path (absolute or relative to current executing script)</span>            </li>
1244                      <li>
1245                  <span class="var-type">string</span>
1246                  <span class="var-name">1</span><span class="var-description">: cache file path, empty if no present or needed</span>            </li>
1247                  </ul>
1248          
1249          
1250      </div>
1251  <a name="methodloadGlobals" id="loadGlobals"><!-- --></a>
1252  <div class="evenrow">
1253      
1254      <div class="method-header">
1255          <span class="method-title">loadGlobals</span> (line <span class="line-number">428</span>)
1256      </div> 
1257      
1258      <!-- ========== Info from phpDoc block ========= -->
1259  <p class="short-description">Loads global values from persistent storage.</p>
1260  <p class="description"><p>This method is invoked when <a href="../System/TApplication.html#methodonLoadState">OnLoadState</a> event is raised.  After this method, values that are stored in previous requests become  available to the current request via <a href="../System/TApplication.html#methodgetGlobalState">getGlobalState</a>.</p></p>
1261      <ul class="tags">
1262                  <li><span class="field">access:</span> protected</li>
1263              </ul>
1264      
1265      <div class="method-signature">
1266          <span class="method-result">void</span>
1267          <span class="method-name">
1268              loadGlobals
1269          </span>
1270                  ()
1271              </div>
1272      
1273          
1274          
1275      </div>
1276  <a name="methodonAuthentication" id="onAuthentication"><!-- --></a>
1277  <div class="oddrow">
1278      
1279      <div class="method-header">
1280          <span class="method-title">onAuthentication</span> (line <span class="line-number">932</span>)
1281      </div> 
1282      
1283      <!-- ========== Info from phpDoc block ========= -->
1284  <p class="short-description">Raises OnAuthentication event.</p>
1285  <p class="description"><p>This method is invoked when the user request needs to be authenticated.</p></p>
1286      <ul class="tags">
1287                  <li><span class="field">access:</span> public</li>
1288              </ul>
1289      
1290      <div class="method-signature">
1291          <span class="method-result">void</span>
1292          <span class="method-name">
1293              onAuthentication
1294          </span>
1295                  ()
1296              </div>
1297      
1298          
1299          
1300      </div>
1301  <a name="methodonAuthenticationComplete" id="onAuthenticationComplete"><!-- --></a>
1302  <div class="evenrow">
1303      
1304      <div class="method-header">
1305          <span class="method-title">onAuthenticationComplete</span> (line <span class="line-number">941</span>)
1306      </div> 
1307      
1308      <!-- ========== Info from phpDoc block ========= -->
1309  <p class="short-description">Raises OnAuthenticationComplete event.</p>
1310  <p class="description"><p>This method is invoked right after the user request is authenticated.</p></p>
1311      <ul class="tags">
1312                  <li><span class="field">access:</span> public</li>
1313              </ul>
1314      
1315      <div class="method-signature">
1316          <span class="method-result">void</span>
1317          <span class="method-name">
1318              onAuthenticationComplete
1319          </span>
1320                  ()
1321              </div>
1322      
1323          
1324          
1325      </div>
1326  <a name="methodonAuthorization" id="onAuthorization"><!-- --></a>
1327  <div class="oddrow">
1328      
1329      <div class="method-header">
1330          <span class="method-title">onAuthorization</span> (line <span class="line-number">950</span>)
1331      </div> 
1332      
1333      <!-- ========== Info from phpDoc block ========= -->
1334  <p class="short-description">Raises OnAuthorization event.</p>
1335  <p class="description"><p>This method is invoked when the user request needs to be authorized.</p></p>
1336      <ul class="tags">
1337                  <li><span class="field">access:</span> public</li>
1338              </ul>
1339      
1340      <div class="method-signature">
1341          <span class="method-result">void</span>
1342          <span class="method-name">
1343              onAuthorization
1344          </span>
1345                  ()
1346              </div>
1347      
1348          
1349          
1350      </div>
1351  <a name="methodonAuthorizationComplete" id="onAuthorizationComplete"><!-- --></a>
1352  <div class="evenrow">
1353      
1354      <div class="method-header">
1355          <span class="method-title">onAuthorizationComplete</span> (line <span class="line-number">959</span>)
1356      </div> 
1357      
1358      <!-- ========== Info from phpDoc block ========= -->
1359  <p class="short-description">Raises OnAuthorizationComplete event.</p>
1360  <p class="description"><p>This method is invoked right after the user request is authorized.</p></p>
1361      <ul class="tags">
1362                  <li><span class="field">access:</span> public</li>
1363              </ul>
1364      
1365      <div class="method-signature">
1366          <span class="method-result">void</span>
1367          <span class="method-name">
1368              onAuthorizationComplete
1369          </span>
1370                  ()
1371              </div>
1372      
1373          
1374          
1375      </div>
1376  <a name="methodonBeginRequest" id="onBeginRequest"><!-- --></a>
1377  <div class="oddrow">
1378      
1379      <div class="method-header">
1380          <span class="method-title">onBeginRequest</span> (line <span class="line-number">923</span>)
1381      </div> 
1382      
1383      <!-- ========== Info from phpDoc block ========= -->
1384  <p class="short-description">Raises OnBeginRequest event.</p>
1385  <p class="description"><p>At the time when this method is invoked, application modules are loaded  and initialized, user request is resolved and the corresponding service  is loaded and initialized. The application is about to start processing  the user request.</p></p>
1386      <ul class="tags">
1387                  <li><span class="field">access:</span> public</li>
1388              </ul>
1389      
1390      <div class="method-signature">
1391          <span class="method-result">void</span>
1392          <span class="method-name">
1393              onBeginRequest
1394          </span>
1395                  ()
1396              </div>
1397      
1398          
1399          
1400      </div>
1401  <a name="methodonEndRequest" id="onEndRequest"><!-- --></a>
1402  <div class="evenrow">
1403      
1404      <div class="method-header">
1405          <span class="method-title">onEndRequest</span> (line <span class="line-number">1041</span>)
1406      </div> 
1407      
1408      <!-- ========== Info from phpDoc block ========= -->
1409  <p class="short-description">Raises OnEndRequest event.</p>
1410  <p class="description"><p>This method is invoked when the application completes the processing of the request.</p></p>
1411      <ul class="tags">
1412                  <li><span class="field">access:</span> public</li>
1413              </ul>
1414      
1415      <div class="method-signature">
1416          <span class="method-result">void</span>
1417          <span class="method-name">
1418              onEndRequest
1419          </span>
1420                  ()
1421              </div>
1422      
1423          
1424          
1425      </div>
1426  <a name="methodonError" id="onError"><!-- --></a>
1427  <div class="oddrow">
1428      
1429      <div class="method-header">
1430          <span class="method-title">onError</span> (line <span class="line-number">909</span>)
1431      </div> 
1432      
1433      <!-- ========== Info from phpDoc block ========= -->
1434  <p class="short-description">Raises OnError event.</p>
1435  <p class="description"><p>This method is invoked when an exception is raised during the lifecycles  of the application.</p></p>
1436      <ul class="tags">
1437                  <li><span class="field">access:</span> public</li>
1438              </ul>
1439      
1440      <div class="method-signature">
1441          <span class="method-result">void</span>
1442          <span class="method-name">
1443              onError
1444          </span>
1445                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$param</span>)
1446              </div>
1447      
1448              <ul class="parameters">
1449                      <li>
1450                  <span class="var-type">mixed</span>
1451                  <span class="var-name">$param</span><span class="var-description">: event parameter</span>            </li>
1452                  </ul>
1453          
1454          
1455      </div>
1456  <a name="methodonLoadState" id="onLoadState"><!-- --></a>
1457  <div class="evenrow">
1458      
1459      <div class="method-header">
1460          <span class="method-title">onLoadState</span> (line <span class="line-number">968</span>)
1461      </div> 
1462      
1463      <!-- ========== Info from phpDoc block ========= -->
1464  <p class="short-description">Raises OnLoadState event.</p>
1465  <p class="description"><p>This method is invoked when the application needs to load state (probably stored in session).</p></p>
1466      <ul class="tags">
1467                  <li><span class="field">access:</span> public</li>
1468              </ul>
1469      
1470      <div class="method-signature">
1471          <span class="method-result">void</span>
1472          <span class="method-name">
1473              onLoadState
1474          </span>
1475                  ()
1476              </div>
1477      
1478          
1479          
1480      </div>
1481  <a name="methodonLoadStateComplete" id="onLoadStateComplete"><!-- --></a>
1482  <div class="oddrow">
1483      
1484      <div class="method-header">
1485          <span class="method-title">onLoadStateComplete</span> (line <span class="line-number">978</span>)
1486      </div> 
1487      
1488      <!-- ========== Info from phpDoc block ========= -->
1489  <p class="short-description">Raises OnLoadStateComplete event.</p>
1490  <p class="description"><p>This method is invoked right after the application state has been loaded.</p></p>
1491      <ul class="tags">
1492                  <li><span class="field">access:</span> public</li>
1493              </ul>
1494      
1495      <div class="method-signature">
1496          <span class="method-result">void</span>
1497          <span class="method-name">
1498              onLoadStateComplete
1499          </span>
1500                  ()
1501              </div>
1502      
1503          
1504          
1505      </div>
1506  <a name="methodonPreFlushOutput" id="onPreFlushOutput"><!-- --></a>
1507  <div class="evenrow">
1508      
1509      <div class="method-header">
1510          <span class="method-title">onPreFlushOutput</span> (line <span class="line-number">1024</span>)
1511      </div> 
1512      
1513      <!-- ========== Info from phpDoc block ========= -->
1514  <p class="short-description">Raises OnPreFlushOutput event.</p>
1515  <p class="description"><p>This method is invoked right before the application flushes output to client.</p></p>
1516      <ul class="tags">
1517                  <li><span class="field">access:</span> public</li>
1518              </ul>
1519      
1520      <div class="method-signature">
1521          <span class="method-result">void</span>
1522          <span class="method-name">
1523              onPreFlushOutput
1524          </span>
1525                  ()
1526              </div>
1527      
1528          
1529          
1530      </div>
1531  <a name="methodonPreRunService" id="onPreRunService"><!-- --></a>
1532  <div class="oddrow">
1533      
1534      <div class="method-header">
1535          <span class="method-title">onPreRunService</span> (line <span class="line-number">987</span>)
1536      </div> 
1537      
1538      <!-- ========== Info from phpDoc block ========= -->
1539  <p class="short-description">Raises OnPreRunService event.</p>
1540  <p class="description"><p>This method is invoked right before the service is to be run.</p></p>
1541      <ul class="tags">
1542                  <li><span class="field">access:</span> public</li>
1543              </ul>
1544      
1545      <div class="method-signature">
1546          <span class="method-result">void</span>
1547          <span class="method-name">
1548              onPreRunService
1549          </span>
1550                  ()
1551              </div>
1552      
1553          
1554          
1555      </div>
1556  <a name="methodonSaveState" id="onSaveState"><!-- --></a>
1557  <div class="evenrow">
1558      
1559      <div class="method-header">
1560          <span class="method-title">onSaveState</span> (line <span class="line-number">1005</span>)
1561      </div> 
1562      
1563      <!-- ========== Info from phpDoc block ========= -->
1564  <p class="short-description">Raises OnSaveState event.</p>
1565  <p class="description"><p>This method is invoked when the application needs to save state (probably stored in session).</p></p>
1566      <ul class="tags">
1567                  <li><span class="field">access:</span> public</li>
1568              </ul>
1569      
1570      <div class="method-signature">
1571          <span class="method-result">void</span>
1572          <span class="method-name">
1573              onSaveState
1574          </span>
1575                  ()
1576              </div>
1577      
1578          
1579          
1580      </div>
1581  <a name="methodonSaveStateComplete" id="onSaveStateComplete"><!-- --></a>
1582  <div class="oddrow">
1583      
1584      <div class="method-header">
1585          <span class="method-title">onSaveStateComplete</span> (line <span class="line-number">1015</span>)
1586      </div> 
1587      
1588      <!-- ========== Info from phpDoc block ========= -->
1589  <p class="short-description">Raises OnSaveStateComplete event.</p>
1590  <p class="description"><p>This method is invoked right after the application state has been saved.</p></p>
1591      <ul class="tags">
1592                  <li><span class="field">access:</span> public</li>
1593              </ul>
1594      
1595      <div class="method-signature">
1596          <span class="method-result">void</span>
1597          <span class="method-name">
1598              onSaveStateComplete
1599          </span>
1600                  ()
1601              </div>
1602      
1603          
1604          
1605      </div>
1606  <a name="methodrun" id="run"><!-- --></a>
1607  <div class="evenrow">
1608      
1609      <div class="method-header">
1610          <span class="method-title">run</span> (line <span class="line-number">334</span>)
1611      </div> 
1612      
1613      <!-- ========== Info from phpDoc block ========= -->
1614  <p class="short-description">Executes the lifecycles of the application.</p>
1615  <p class="description"><p>This is the main entry function that leads to the running of the whole  Prado application.</p></p>
1616      <ul class="tags">
1617                  <li><span class="field">access:</span> public</li>
1618              </ul>
1619      
1620      <div class="method-signature">
1621          <span class="method-result">void</span>
1622          <span class="method-name">
1623              run
1624          </span>
1625                  ()
1626              </div>
1627      
1628          
1629          
1630      </div>
1631  <a name="methodrunService" id="runService"><!-- --></a>
1632  <div class="oddrow">
1633      
1634      <div class="method-header">
1635          <span class="method-title">runService</span> (line <span class="line-number">995</span>)
1636      </div> 
1637      
1638      <!-- ========== Info from phpDoc block ========= -->
1639  <p class="short-description">Runs the requested service.</p>
1640      <ul class="tags">
1641                  <li><span class="field">access:</span> public</li>
1642              </ul>
1643      
1644      <div class="method-signature">
1645          <span class="method-result">void</span>
1646          <span class="method-name">
1647              runService
1648          </span>
1649                  ()
1650              </div>
1651      
1652          
1653          
1654      </div>
1655  <a name="methodsaveGlobals" id="saveGlobals"><!-- --></a>
1656  <div class="evenrow">
1657      
1658      <div class="method-header">
1659          <span class="method-title">saveGlobals</span> (line <span class="line-number">437</span>)
1660      </div> 
1661      
1662      <!-- ========== Info from phpDoc block ========= -->
1663  <p class="short-description">Saves global values into persistent storage.</p>
1664  <p class="description"><p>This method is invoked when <a href="../System/TApplication.html#methodonSaveState">OnSaveState</a> event is raised.</p></p>
1665      <ul class="tags">
1666                  <li><span class="field">access:</span> protected</li>
1667              </ul>
1668      
1669      <div class="method-signature">
1670          <span class="method-result">void</span>
1671          <span class="method-name">
1672              saveGlobals
1673          </span>
1674                  ()
1675              </div>
1676      
1677          
1678          
1679      </div>
1680  <a name="methodsetApplicationStatePersister" id="setApplicationStatePersister"><!-- --></a>
1681  <div class="oddrow">
1682      
1683      <div class="method-header">
1684          <span class="method-title">setApplicationStatePersister</span> (line <span class="line-number">725</span>)
1685      </div> 
1686      
1687      <!-- ========== Info from phpDoc block ========= -->
1688      <ul class="tags">
1689                  <li><span class="field">access:</span> public</li>
1690              </ul>
1691      
1692      <div class="method-signature">
1693          <span class="method-result">void</span>
1694          <span class="method-name">
1695              setApplicationStatePersister
1696          </span>
1697                      (<span class="var-type">IStatePersister</span>&nbsp;<span class="var-name">$persister</span>)
1698              </div>
1699      
1700              <ul class="parameters">
1701                      <li>
1702                  <span class="var-type"><a href="../System/IStatePersister.html">IStatePersister</a></span>
1703                  <span class="var-name">$persister</span><span class="var-description">: application state persister</span>            </li>
1704                  </ul>
1705          
1706          
1707      </div>
1708  <a name="methodsetAssetManager" id="setAssetManager"><!-- --></a>
1709  <div class="evenrow">
1710      
1711      <div class="method-header">
1712          <span class="method-title">setAssetManager</span> (line <span class="line-number">704</span>)
1713      </div> 
1714      
1715      <!-- ========== Info from phpDoc block ========= -->
1716      <ul class="tags">
1717                  <li><span class="field">access:</span> public</li>
1718              </ul>
1719      
1720      <div class="method-signature">
1721          <span class="method-result">void</span>
1722          <span class="method-name">
1723              setAssetManager
1724          </span>
1725                      (<span class="var-type">TAssetManager</span>&nbsp;<span class="var-name">$value</span>)
1726              </div>
1727      
1728              <ul class="parameters">
1729                      <li>
1730                  <span class="var-type"><a href="../System.Web/TAssetManager.html">TAssetManager</a></span>
1731                  <span class="var-name">$value</span><span class="var-description">: asset manager</span>            </li>
1732                  </ul>
1733          
1734          
1735      </div>
1736  <a name="methodsetCache" id="setCache"><!-- --></a>
1737  <div class="oddrow">
1738      
1739      <div class="method-header">
1740          <span class="method-title">setCache</span> (line <span class="line-number">741</span>)
1741      </div> 
1742      
1743      <!-- ========== Info from phpDoc block ========= -->
1744      <ul class="tags">
1745                  <li><span class="field">access:</span> public</li>
1746              </ul>
1747      
1748      <div class="method-signature">
1749          <span class="method-result">void</span>
1750          <span class="method-name">
1751              setCache
1752          </span>
1753                      (<span class="var-type">ICache</span>&nbsp;<span class="var-name">$cache</span>)
1754              </div>
1755      
1756              <ul class="parameters">
1757                      <li>
1758                  <span class="var-type"><a href="../System/ICache.html">ICache</a></span>
1759                  <span class="var-name">$cache</span><span class="var-description">: the cache module</span>            </li>
1760                  </ul>
1761          
1762          
1763      </div>
1764  <a name="methodsetErrorHandler" id="setErrorHandler"><!-- --></a>
1765  <div class="evenrow">
1766      
1767      <div class="method-header">
1768          <span class="method-title">setErrorHandler</span> (line <span class="line-number">662</span>)
1769      </div> 
1770      
1771      <!-- ========== Info from phpDoc block ========= -->
1772      <ul class="tags">
1773                  <li><span class="field">access:</span> public</li>
1774              </ul>
1775      
1776      <div class="method-signature">
1777          <span class="method-result">void</span>
1778          <span class="method-name">
1779              setErrorHandler
1780          </span>
1781                      (<span class="var-type">TErrorHandler</span>&nbsp;<span class="var-name">$handler</span>)
1782              </div>
1783      
1784              <ul class="parameters">
1785                      <li>
1786                  <span class="var-type"><a href="../System.Exceptions/TErrorHandler.html">TErrorHandler</a></span>
1787                  <span class="var-name">$handler</span><span class="var-description">: the error hanlder module</span>            </li>
1788                  </ul>
1789          
1790          
1791      </div>
1792  <a name="methodsetGlobalization" id="setGlobalization"><!-- --></a>
1793  <div class="oddrow">
1794      
1795      <div class="method-header">
1796          <span class="method-title">setGlobalization</span> (line <span class="line-number">776</span>)
1797      </div> 
1798      
1799      <!-- ========== Info from phpDoc block ========= -->
1800      <ul class="tags">
1801                  <li><span class="field">access:</span> public</li>
1802              </ul>
1803      
1804      <div class="method-signature">
1805          <span class="method-result">void</span>
1806          <span class="method-name">
1807              setGlobalization
1808          </span>
1809                      (<span class="var-type">TGlobalization</span>&nbsp;<span class="var-name">$glob</span>)
1810              </div>
1811      
1812              <ul class="parameters">
1813                      <li>
1814                  <span class="var-type"><a href="../System.I18N/TGlobalization.html">TGlobalization</a></span>
1815                  <span class="var-name">$glob</span><span class="var-description">: globalization module</span>            </li>
1816                  </ul>
1817          
1818          
1819      </div>
1820  <a name="methodsetGlobalState" id="setGlobalState"><!-- --></a>
1821  <div class="evenrow">
1822      
1823      <div class="method-header">
1824          <span class="method-title">setGlobalState</span> (line <span class="line-number">401</span>)
1825      </div> 
1826      
1827      <!-- ========== Info from phpDoc block ========= -->
1828  <p class="short-description">Sets a global value.</p>
1829  <p class="description"><p>A global value is one that is persistent across users sessions and requests.  Make sure that the value is serializable and unserializable.</p></p>
1830      <ul class="tags">
1831                  <li><span class="field">access:</span> public</li>
1832              </ul>
1833      
1834      <div class="method-signature">
1835          <span class="method-result">void</span>
1836          <span class="method-name">
1837              setGlobalState
1838          </span>
1839                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$defaultValue</span> = <span class="var-default">null</span>])
1840              </div>
1841      
1842              <ul class="parameters">
1843                      <li>
1844                  <span class="var-type">string</span>
1845                  <span class="var-name">$key</span><span class="var-description">: the name of the value to be set</span>            </li>
1846                      <li>
1847                  <span class="var-type">mixed</span>
1848                  <span class="var-name">$value</span><span class="var-description">: the global value to be set</span>            </li>
1849                      <li>
1850                  <span class="var-type">mixed</span>
1851                  <span class="var-name">$defaultValue</span><span class="var-description">: the default value. If $key is not found, $defaultValue will be returned</span>            </li>
1852                  </ul>
1853          
1854          
1855      </div>
1856  <a name="methodsetID" id="setID"><!-- --></a>
1857  <div class="oddrow">
1858      
1859      <div class="method-header">
1860          <span class="method-title">setID</span> (line <span class="line-number">457</span>)
1861      </div> 
1862      
1863      <!-- ========== Info from phpDoc block ========= -->
1864      <ul class="tags">
1865                  <li><span class="field">access:</span> public</li>
1866              </ul>
1867      
1868      <div class="method-signature">
1869          <span class="method-result">void</span>
1870          <span class="method-name">
1871              setID
1872          </span>
1873                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
1874              </div>
1875      
1876              <ul class="parameters">
1877                      <li>
1878                  <span class="var-type">string</span>
1879                  <span class="var-name">$value</span><span class="var-description">: application ID</span>            </li>
1880                  </ul>
1881          
1882          
1883      </div>
1884  <a name="methodsetMode" id="setMode"><!-- --></a>
1885  <div class="evenrow">
1886      
1887      <div class="method-header">
1888          <span class="method-title">setMode</span> (line <span class="line-number">481</span>)
1889      </div> 
1890      
1891      <!-- ========== Info from phpDoc block ========= -->
1892      <ul class="tags">
1893                  <li><span class="field">access:</span> public</li>
1894              </ul>
1895      
1896      <div class="method-signature">
1897          <span class="method-result">void</span>
1898          <span class="method-name">
1899              setMode
1900          </span>
1901                      (<span class="var-type"><a href="../System/TApplicationMode.html">TApplicationMode</a></span>&nbsp;<span class="var-name">$value</span>)
1902              </div>
1903      
1904              <ul class="parameters">
1905                      <li>
1906                  <span class="var-type"><a href="../System/TApplicationMode.html">TApplicationMode</a></span>
1907                  <span class="var-name">$value</span><span class="var-description">: application mode</span>            </li>
1908                  </ul>
1909          
1910          
1911      </div>
1912  <a name="methodsetModule" id="setModule"><!-- --></a>
1913  <div class="oddrow">
1914      
1915      <div class="method-header">
1916          <span class="method-title">setModule</span> (line <span class="line-number">525</span>)
1917      </div> 
1918      
1919      <!-- ========== Info from phpDoc block ========= -->
1920  <p class="short-description">Adds a module to application.</p>
1921  <p class="description"><p>Note, this method does not do module initialization.</p></p>
1922      <ul class="tags">
1923                  <li><span class="field">access:</span> public</li>
1924              </ul>
1925      
1926      <div class="method-signature">
1927          <span class="method-result">void</span>
1928          <span class="method-name">
1929              setModule
1930          </span>
1931                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">IModule</span>&nbsp;<span class="var-name">$module</span>)
1932              </div>
1933      
1934              <ul class="parameters">
1935                      <li>
1936                  <span class="var-type">string</span>
1937                  <span class="var-name">$id</span><span class="var-description">: ID of the module</span>            </li>
1938                      <li>
1939                  <span class="var-type"><a href="../System/IModule.html">IModule</a></span>
1940                  <span class="var-name">$module</span><span class="var-description">: module object</span>            </li>
1941                  </ul>
1942          
1943          
1944      </div>
1945  <a name="methodsetPageService" id="setPageService"><!-- --></a>
1946  <div class="evenrow">
1947      
1948      <div class="method-header">
1949          <span class="method-title">setPageService</span> (line <span class="line-number">578</span>)
1950      </div> 
1951      
1952      <!-- ========== Info from phpDoc block ========= -->
1953  <p class="short-description">Registers the page service instance.</p>
1954  <p class="description"><p>This method should only be used by framework developers.</p></p>
1955      <ul class="tags">
1956                  <li><span class="field">access:</span> public</li>
1957              </ul>
1958      
1959      <div class="method-signature">
1960          <span class="method-result">void</span>
1961          <span class="method-name">
1962              setPageService
1963          </span>
1964                      (<span class="var-type">TPageService</span>&nbsp;<span class="var-name">$service</span>)
1965              </div>
1966      
1967              <ul class="parameters">
1968                      <li>
1969                  <span class="var-type"><a href="../System.Web.Services/TPageService.html">TPageService</a></span>
1970                  <span class="var-name">$service</span><span class="var-description">: page service</span>            </li>
1971                  </ul>
1972          
1973          
1974      </div>
1975  <a name="methodsetRequest" id="setRequest"><!-- --></a>
1976  <div class="oddrow">
1977      
1978      <div class="method-header">
1979          <span class="method-title">setRequest</span> (line <span class="line-number">599</span>)
1980      </div> 
1981      
1982      <!-- ========== Info from phpDoc block ========= -->
1983      <ul class="tags">
1984                  <li><span class="field">access:</span> public</li>
1985              </ul>
1986      
1987      <div class="method-signature">
1988          <span class="method-result">void</span>
1989          <span class="method-name">
1990              setRequest
1991          </span>
1992                      (<span class="var-type">THttpRequest</span>&nbsp;<span class="var-name">$request</span>)
1993              </div>
1994      
1995              <ul class="parameters">
1996                      <li>
1997                  <span class="var-type"><a href="../System.Web/THttpRequest.html">THttpRequest</a></span>
1998                  <span class="var-name">$request</span><span class="var-description">: the request module</span>            </li>
1999                  </ul>
2000          
2001          
2002      </div>
2003  <a name="methodsetResponse" id="setResponse"><!-- --></a>
2004  <div class="evenrow">
2005      
2006      <div class="method-header">
2007          <span class="method-title">setResponse</span> (line <span class="line-number">620</span>)
2008      </div> 
2009      
2010      <!-- ========== Info from phpDoc block ========= -->
2011      <ul class="tags">
2012                  <li><span class="field">access:</span> public</li>
2013              </ul>
2014      
2015      <div class="method-signature">
2016          <span class="method-result">void</span>
2017          <span class="method-name">
2018              setResponse
2019          </span>
2020                      (<span class="var-type">THttpResponse</span>&nbsp;<span class="var-name">$response</span>)
2021              </div>
2022      
2023              <ul class="parameters">
2024                      <li>
2025                  <span class="var-type"><a href="../System.Web/THttpRequest.html">THttpRequest</a></span>
2026                  <span class="var-name">$response</span><span class="var-description">: the request module</span>            </li>
2027                  </ul>
2028          
2029          
2030      </div>
2031  <a name="methodsetSecurityManager" id="setSecurityManager"><!-- --></a>
2032  <div class="oddrow">
2033      
2034      <div class="method-header">
2035          <span class="method-title">setSecurityManager</span> (line <span class="line-number">683</span>)
2036      </div> 
2037      
2038      <!-- ========== Info from phpDoc block ========= -->
2039      <ul class="tags">
2040                  <li><span class="field">access:</span> public</li>
2041              </ul>
2042      
2043      <div class="method-signature">
2044          <span class="method-result">void</span>
2045          <span class="method-name">
2046              setSecurityManager
2047          </span>
2048                      (<span class="var-type">TSecurityManager</span>&nbsp;<span class="var-name">$sm</span>)
2049              </div>
2050      
2051              <ul class="parameters">
2052                      <li>
2053                  <span class="var-type"><a href="../System.Security/TSecurityManager.html">TSecurityManager</a></span>
2054                  <span class="var-name">$sm</span><span class="var-description">: the security manager module</span>            </li>
2055                  </ul>
2056          
2057          
2058      </div>
2059  <a name="methodsetSession" id="setSession"><!-- --></a>
2060  <div class="evenrow">
2061      
2062      <div class="method-header">
2063          <span class="method-title">setSession</span> (line <span class="line-number">641</span>)
2064      </div> 
2065      
2066      <!-- ========== Info from phpDoc block ========= -->
2067      <ul class="tags">
2068                  <li><span class="field">access:</span> public</li>
2069              </ul>
2070      
2071      <div class="method-signature">
2072          <span class="method-result">void</span>
2073          <span class="method-name">
2074              setSession
2075          </span>
2076                      (<span class="var-type">THttpSession</span>&nbsp;<span class="var-name">$session</span>)
2077              </div>
2078      
2079              <ul class="parameters">
2080                      <li>
2081                  <span class="var-type"><a href="../System.Web/THttpSession.html">THttpSession</a></span>
2082                  <span class="var-name">$session</span><span class="var-description">: the session module</span>            </li>
2083                  </ul>
2084          
2085          
2086      </div>
2087  <a name="methodsetUser" id="setUser"><!-- --></a>
2088  <div class="oddrow">
2089      
2090      <div class="method-header">
2091          <span class="method-title">setUser</span> (line <span class="line-number">757</span>)
2092      </div> 
2093      
2094      <!-- ========== Info from phpDoc block ========= -->
2095      <ul class="tags">
2096                  <li><span class="field">access:</span> public</li>
2097              </ul>
2098      
2099      <div class="method-signature">
2100          <span class="method-result">void</span>
2101          <span class="method-name">
2102              setUser
2103          </span>
2104                      (<span class="var-type">IUser</span>&nbsp;<span class="var-name">$user</span>)
2105              </div>
2106      
2107              <ul class="parameters">
2108                      <li>
2109                  <span class="var-type"><a href="../System/IUser.html">IUser</a></span>
2110                  <span class="var-name">$user</span><span class="var-description">: the application user</span>            </li>
2111                  </ul>
2112          
2113          
2114      </div>
2115                              <h4>Inherited Methods</h4>
2116                  <a name='inherited_methods'><!-- --></a>    
2117                                      <!-- =========== Summary =========== -->
2118                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
2119                      <blockquote>
2120                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
2121                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
2122                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
2123                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
2124                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
2125                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
2126                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
2127                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
2128                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
2129                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
2130                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
2131                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
2132                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
2133                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
2134                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
2135                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
2136                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
2137                                              </blockquote>
2138                                          
2139          </div>
2140      </div>
2141  
2142      <a name="sec-consts"></a>
2143      <div class="info-box">
2144          <div class="info-box-title">Class Constants</div>
2145          <div class="nav-bar">
2146              <a href="#sec-description">Description</a> |
2147                                          <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
2148                          
2149              
2150                                          | 
2151                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
2152                              
2153                      </div>
2154          <div class="info-box-body">
2155              <a name="constCONFIGCACHE_FILE" id="CONFIGCACHE_FILE"><!-- --></A>
2156  <div class="evenrow">
2157  
2158      <div class="const-header">
2159          <img src="../media/images/Variable.png" />
2160          <span class="const-title">
2161              <span class="const-name">CONFIGCACHE_FILE</span>
2162               = <span class="const-default">'config.cache'</span>
2163              (line <span class="line-number">138</span>)
2164          </span>
2165      </div>
2166  
2167      <!-- ========== Info from phpDoc block ========= -->
2168  <p class="short-description">Config cache file</p>
2169      
2170      
2171  </div>
2172  <a name="constCONFIG_FILE" id="CONFIG_FILE"><!-- --></A>
2173  <div class="oddrow">
2174  
2175      <div class="const-header">
2176          <img src="../media/images/Variable.png" />
2177          <span class="const-title">
2178              <span class="const-name">CONFIG_FILE</span>
2179               = <span class="const-default">'application.xml'</span>
2180              (line <span class="line-number">130</span>)
2181          </span>
2182      </div>
2183  
2184      <!-- ========== Info from phpDoc block ========= -->
2185  <p class="short-description">Application configuration file name</p>
2186      
2187      
2188  </div>
2189  <a name="constGLOBAL_FILE" id="GLOBAL_FILE"><!-- --></A>
2190  <div class="evenrow">
2191  
2192      <div class="const-header">
2193          <img src="../media/images/Variable.png" />
2194          <span class="const-title">
2195              <span class="const-name">GLOBAL_FILE</span>
2196               = <span class="const-default">'global.cache'</span>
2197              (line <span class="line-number">142</span>)
2198          </span>
2199      </div>
2200  
2201      <!-- ========== Info from phpDoc block ========= -->
2202  <p class="short-description">Global data file</p>
2203      
2204      
2205  </div>
2206  <a name="constPAGE_SERVICE_ID" id="PAGE_SERVICE_ID"><!-- --></A>
2207  <div class="oddrow">
2208  
2209      <div class="const-header">
2210          <img src="../media/images/Variable.png" />
2211          <span class="const-title">
2212              <span class="const-name">PAGE_SERVICE_ID</span>
2213               = <span class="const-default">'page'</span>
2214              (line <span class="line-number">126</span>)
2215          </span>
2216      </div>
2217  
2218      <!-- ========== Info from phpDoc block ========= -->
2219  <p class="short-description">Page service ID</p>
2220      
2221      
2222  </div>
2223  <a name="constRUNTIME_PATH" id="RUNTIME_PATH"><!-- --></A>
2224  <div class="evenrow">
2225  
2226      <div class="const-header">
2227          <img src="../media/images/Variable.png" />
2228          <span class="const-title">
2229              <span class="const-name">RUNTIME_PATH</span>
2230               = <span class="const-default">'runtime'</span>
2231              (line <span class="line-number">134</span>)
2232          </span>
22ncPopup(event,'__get')">__geclass="linenum">22302135         2                    from phpDoc block ========= -->
2136         23e="constPAGE_cription">Page service ID</p&gR name= directory="l2186">2137         2name="l2038">2138         2                   class="linen2m">2229          3ss="short-des302140      <24lass="evenrowME_PATH" id=&STATE_DEBUG_PATH">&STATE_DEBUG_PATH&A>
2141  
2142      <2a name="seclass="linenum">22ncPopup(event,'__get')"div class="info-box">
2144         2<div class="info-boimages/Variable.png" />
2145         2<span class="method-name">
2146         2    <a href="#sec-descrname">RUNTIME_PATH</span&gSTATE_DEBUG_2233">2147         2                            const-default">'runtime'</span>
2148         2                
2149         2    
2150         2                   -des302151         25"l2192">2152         2                    from phpDoc block ========= -->
2153         2            </diclass="linenum">2144         2<div class="class="linenum">2145         25gt;
2156  <div2class="evenrowME_PATH" id=&STATE_NORMAL_PATH">&STATE_NORMAL_PATH&A>
2157  
2158      <25"l2209">2159         2<img src=".o-box">
2160         2<span class="const-images/Variable.png" />
2161         2    <span class="hod-name">
2162         2     = <span class="escrname">RUNTIME_PATH</span&gSTATE_NORMAL_2231">2163         2    (line <span class=&q const-default">'runtime'</span>
2164         2</span>
2165      <2/div>
2166  
2167      <26"l2218">2168  <p c2        <li>& from phpDoc block ========= -->
2169      
2170      
2171  </di2>
2172  <a n2me="constCONFIG_FILE" id=&qSTATE_OFF_PATH">&STATE_OFF_PATH&A>
2173  <div2class="oddrow">
2174  
2175      <2div class="const-header">
2176         2<img src="../media/images/Variable.png" />
2177         2<span class="const-title">
2178         2    <span class="const-name">CONFIG_FILE</span>STATE_OFF_2231">2179         2     = <span class="const-default">'application.xml'</spOff"l2180">2180         2    (line <span class="line-number">130</span>)
2181         2</span>
2182      <2/div>
2183  
2184      <2!-- ========== Info from phpDoc block ========= -->
2185  <p c2ass="short-description">Application configuratipossinampan>      mode.86">2186      
2187      
2188  </di28   <span class="const->2189  <a n2name="l2090">2190  <div2div class="metclass="linen2m">2181         29gt;
2192      <29e="constCONFIG_FILE" id=&qSTATE_PERFORMANC_FILE">&lSTATE_PERFORMANC_FILE&qA>
2193         29lass="oddrow">
2194         29"l2175">2195         2ul class="tags&quoeader">
2196         2     = <span class=&dia/images/Variable.png" />
2197         2    (line <span clasnst-title">
2198         2</span>
2199      <2/div>
2200  
2201      <3<span class="method0">2192      <3    setUser
2203      
2204      
2205  </di3    </div>
2196         3name="l2107">2207  <div3class="oddrow&">2198         3="l2209">2199      <3        <span class=row&">2210         3<img src=".row&">2201      <31"l2192">2212         3    <span class=-description"notesFILE">&lcrg&qt78">2213         3     = <span class=>ut;/s      gener;/a&    Mon, 04 Dec 2006 11:25:51 -0500 bymethod-summary&quohttp://www.--&doc.orl2177">2214         3/div>
         3</span>
2196         31lass="evenrow/t<an