[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 TApplicationComponent</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 TApplicationComponent</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-descendents">Descendents</a>
  20              |                                                    <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  21                          
  22                      </div>
  23      <div class="info-box-body">
  24                  <!-- ========== Info from phpDoc block ========= -->
  25  <p class="short-description">TApplicationComponent class</p>
  26  <p class="description"><p>TApplicationComponent is the base class for all components that are  application-related, such as controls, modules, services, etc.</p><p>TApplicationComponent mainly defines a few properties that are shortcuts  to some commonly used methods. The <a href="../System/TApplicationComponent.html#methodgetApplication">Application</a>  property gives the application instance that this component belongs to;  <a href="../System/TApplicationComponent.html#methodgetService">Service</a> gives the current running service;  <a href="../System/TApplicationComponent.html#methodgetRequest">Request</a>, <a href="../System/TApplicationComponent.html#methodgetResponse">Response</a> and <a href="../System/TApplicationComponent.html#methodgetSession">Session</a>  return the request and response modules, respectively;  And <a href="../System/TApplicationComponent.html#methodgetUser">User</a> gives the current user instance.</p><p>Besides, TApplicationComponent defines two shortcut methods for  publishing private files: <a href="../System/TApplicationComponent.html#methodpublishAsset">publishAsset</a> and <a href="../System/TApplicationComponent.html#methodpublishFilePath">publishFilePath</a>.</p></p>
  27      <ul class="tags">
  28                  <li><span class="field">since:</span> 3.0</li>
  29                  <li><span class="field">version:</span> $Id: TApplicationComponent.php 1397 2006-09-07 07:55:53Z wei $</li>
  30                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  31              </ul>
  32          <p class="notes">
  33              Located in <a class="field" href="_TApplicationComponent_php.html">/TApplicationComponent.php</a> (line <span class="field">35</span>)
  34          </p>
  35          
  36                  
  37          <pre><a href="../System/TComponent.html">TComponent</a>
  38     |
  39     --TApplicationComponent</pre>
  40      
  41              </div>
  42  </div>
  43  
  44      <a name="sec-descendents"></a>
  45      <div class="info-box">
  46          <div class="info-box-title">Direct descendents</div>
  47          <div class="nav-bar">
  48              <a href="#sec-description">Description</a> |
  49              <span class="disabled">Descendents</span>
  50              |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  51                              
  52                                  </div>
  53          <div class="info-box-body">
  54              <table cellpadding="2" cellspacing="0" class="class-table">
  55                  <tr>
  56                      <th class="class-table-header">Class</th>
  57                      <th class="class-table-header">Description</th>
  58                  </tr>
  59                                  <tr>
  60                      <td style="padding-right: 2em"><a href="../System/TModule.html">TModule</a></td>
  61                      <td>
  62                                              TModule class.
  63                                          </td>
  64                  </tr>
  65                                  <tr>
  66                      <td style="padding-right: 2em"><a href="../System/TService.html">TService</a></td>
  67                      <td>
  68                                              TService class.
  69                                          </td>
  70                  </tr>
  71                                  <tr>
  72                      <td style="padding-right: 2em"><a href="../System.Util/TLogRoute.html">TLogRoute</a></td>
  73                      <td>
  74                                              TLogRoute class.
  75                                          </td>
  76                  </tr>
  77                                  <tr>
  78                      <td style="padding-right: 2em"><a href="../System.Web/THttpRequest.html">THttpRequest</a></td>
  79                      <td>
  80                                              THttpRequest class
  81                                          </td>
  82                  </tr>
  83                                  <tr>
  84                      <td style="padding-right: 2em"><a href="../System.Web/THttpSession.html">THttpSession</a></td>
  85                      <td>
  86                                              THttpSession class
  87                                          </td>
  88                  </tr>
  89                                  <tr>
  90                      <td style="padding-right: 2em"><a href="../System.Web.UI/TClientScriptManager.html">TClientScriptManager</a></td>
  91                      <td>
  92                                              TClientScriptManager class.
  93                                          </td>
  94                  </tr>
  95                                  <tr>
  96                      <td style="padding-right: 2em"><a href="../System.Web.UI/TControl.html">TControl</a></td>
  97                      <td>
  98                                              TControl class
  99                                          </td>
 100                  </tr>
 101                                  <tr>
 102                      <td style="padding-right: 2em"><a href="../System.Web.UI/TControlAdapter.html">TControlAdapter</a></td>
 103                      <td>
 104                                              TControlAdapter class
 105                                          </td>
 106                  </tr>
 107                                  <tr>
 108                      <td style="padding-right: 2em"><a href="../System.Web.UI/THtmlWriter.html">THtmlWriter</a></td>
 109                      <td>
 110                                              THtmlWriter class
 111                                          </td>
 112                  </tr>
 113                                  <tr>
 114                      <td style="padding-right: 2em"><a href="../System.Web.UI/TPageStatePersister.html">TPageStatePersister</a></td>
 115                      <td>
 116                                              TPageStatePersister class
 117                                          </td>
 118                  </tr>
 119                                  <tr>
 120                      <td style="padding-right: 2em"><a href="../System.Web.UI/TTemplate.html">TTemplate</a></td>
 121                      <td>
 122                                              TTemplate implements PRADO template parsing logic.
 123                                          </td>
 124                  </tr>
 125                                  <tr>
 126                      <td style="padding-right: 2em"><a href="../System.Web.UI/TTheme.html">TTheme</a></td>
 127                      <td>
 128                                              TTheme class
 129                                          </td>
 130                  </tr>
 131                                  <tr>
 132                      <td style="padding-right: 2em"><a href="../System.Web.UI.WebControls/TDataGridColumn.html">TDataGridColumn</a></td>
 133                      <td>
 134                                              TDataGridColumn class
 135                                          </td>
 136                  </tr>
 137                              </table>
 138          </div>
 139      </div>
 140  
 141  
 142  
 143      <a name="sec-method-summary"></a>
 144      <div class="info-box">
 145          <div class="info-box-title">Method Summary</span></div>
 146          <div class="nav-bar">
 147              <a href="#sec-description">Description</a> |
 148                              <a href="#sec-descendents">Descendents</a> |
 149                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 150          </div>
 151          <div class="info-box-body">            
 152              <div class="method-summary">
 153                                  
 154                  <div class="method-definition">
 155                                              <span class="method-result"><a href="../System/TApplication.html">TApplication</a></span>
 156                                          <a href="#getApplication" title="details" class="method-name">getApplication</a>
 157                                          ()
 158                                      </div>
 159                                  
 160                  <div class="method-definition">
 161                                              <span class="method-result"><a href="../System.Web/THttpRequest.html">THttpRequest</a></span>
 162                                          <a href="#getRequest" title="details" class="method-name">getRequest</a>
 163                                          ()
 164                                      </div>
 165                                  
 166                  <div class="method-definition">
 167                                              <span class="method-result"><a href="../System.Web/THttpResponse.html">THttpResponse</a></span>
 168                                          <a href="#getResponse" title="details" class="method-name">getResponse</a>
 169                                          ()
 170                                      </div>
 171                                  
 172                  <div class="method-definition">
 173                                              <span class="method-result"><a href="../System/IService.html">IService</a></span>
 174                                          <a href="#getService" title="details" class="method-name">getService</a>
 175                                          ()
 176                                      </div>
 177                                  
 178                  <div class="method-definition">
 179                                              <span class="method-result"><a href="../System.Web/THttpSession.html">THttpSession</a></span>
 180                                          <a href="#getSession" title="details" class="method-name">getSession</a>
 181                                          ()
 182                                      </div>
 183                                  
 184                  <div class="method-definition">
 185                                              <span class="method-result"><a href="../System/IUser.html">IUser</a></span>
 186                                          <a href="#getUser" title="details" class="method-name">getUser</a>
 187                                          ()
 188                                      </div>
 189                                  
 190                  <div class="method-definition">
 191                                              <span class="method-result">string</span>
 192                                          <a href="#publishAsset" title="details" class="method-name">publishAsset</a>
 193                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$assetPath</span>)
 194                                      </div>
 195                                  
 196                  <div class="method-definition">
 197                                              <span class="method-result">string</span>
 198                                          <a href="#publishFilePath" title="details" class="method-name">publishFilePath</a>
 199                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$fullPath</span>)
 200                                      </div>
 201                              </div>
 202          </div>
 203      </div>        
 204  
 205      
 206      <a name="sec-methods"></a>
 207      <div class="info-box">
 208          <div class="info-box-title">Methods</div>
 209          <div class="nav-bar">
 210              <a href="#sec-description">Description</a> |
 211                              <a href="#sec-descendents">Descendents</a> |
 212                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 213                          
 214          </div>
 215          <div class="info-box-body">
 216              <A NAME='method_detail'></A>
 217  <a name="methodgetApplication" id="getApplication"><!-- --></a>
 218  <div class="oddrow">
 219      
 220      <div class="method-header">
 221          <span class="method-title">getApplication</span> (line <span class="line-number">40</span>)
 222      </div> 
 223      
 224      <!-- ========== Info from phpDoc block ========= -->
 225      <ul class="tags">
 226                  <li><span class="field">return:</span> current application instance</li>
 227                  <li><span class="field">access:</span> public</li>
 228              </ul>
 229      
 230      <div class="method-signature">
 231          <span class="method-result"><a href="../System/TApplication.html">TApplication</a></span>
 232          <span class="method-name">
 233              getApplication
 234          </span>
 235                  ()
 236              </div>
 237      
 238          
 239          
 240      </div>
 241  <a name="methodgetRequest" id="getRequest"><!-- --></a>
 242  <div class="evenrow">
 243      
 244      <div class="method-header">
 245          <span class="method-title">getRequest</span> (line <span class="line-number">56</span>)
 246      </div> 
 247      
 248      <!-- ========== Info from phpDoc block ========= -->
 249      <ul class="tags">
 250                  <li><span class="field">return:</span> the current user request</li>
 251                  <li><span class="field">access:</span> public</li>
 252              </ul>
 253      
 254      <div class="method-signature">
 255          <span class="method-result"><a href="../System.Web/THttpRequest.html">THttpRequest</a></span>
 256          <span class="method-name">
 257              getRequest
 258          </span>
 259                  ()
 260              </div>
 261      
 262          
 263          
 264      </div>
 265  <a name="methodgetResponse" id="getResponse"><!-- --></a>
 266  <div class="oddrow">
 267      
 268      <div class="method-header">
 269          <span class="method-title">getResponse</span> (line <span class="line-number">64</span>)
 270      </div> 
 271      
 272      <!-- ========== Info from phpDoc block ========= -->
 273      <ul class="tags">
 274                  <li><span class="field">return:</span> the response</li>
 275                  <li><span class="field">access:</span> public</li>
 276              </ul>
 277      
 278      <div class="method-signature">
 279          <span class="method-result"><a href="../System.Web/THttpResponse.html">THttpResponse</a></span>
 280          <span class="method-name">
 281              getResponse
 282          </span>
 283                  ()
 284              </div>
 285      
 286          
 287          
 288      </div>
 289  <a name="methodgetService" id="getService"><!-- --></a>
 290  <div class="evenrow">
 291      
 292      <div class="method-header">
 293          <span class="method-title">getService</span> (line <span class="line-number">48</span>)
 294      </div> 
 295      
 296      <!-- ========== Info from phpDoc block ========= -->
 297      <ul class="tags">
 298                  <li><span class="field">return:</span> the current service</li>
 299                  <li><span class="field">access:</span> public</li>
 300              </ul>
 301      
 302      <div class="method-signature">
 303          <span class="method-result"><a href="../System/IService.html">IService</a></span>
 304          <span class="method-name">
 305              getService
 306          </span>
 307                  ()
 308              </div>
 309      
 310          
 311          
 312      </div>
 313  <a name="methodgetSession" id="getSession"><!-- --></a>
 314  <div class="oddrow">
 315      
 316      <div class="method-header">
 317          <span class="method-title">getSession</span> (line <span class="line-number">72</span>)
 318      </div> 
 319      
 320      <!-- ========== Info from phpDoc block ========= -->
 321      <ul class="tags">
 322                  <li><span class="field">return:</span> user session</li>
 323                  <li><span class="field">access:</span> public</li>
 324              </ul>
 325      
 326      <div class="method-signature">
 327          <span class="method-result"><a href="../System.Web/THttpSession.html">THttpSession</a></span>
 328          <span class="method-name">
 329              getSession
 330          </span>
 331                  ()
 332              </div>
 333      
 334          
 335          
 336      </div>
 337  <a name="methodgetUser" id="getUser"><!-- --></a>
 338  <div class="evenrow">
 339      
 340      <div class="method-header">
 341          <span class="method-title">getUser</span> (line <span class="line-number">80</span>)
 342      </div> 
 343      
 344      <!-- ========== Info from phpDoc block ========= -->
 345      <ul class="tags">
 346                  <li><span class="field">return:</span> information about the current user</li>
 347                  <li><span class="field">access:</span> public</li>
 348              </ul>
 349      
 350      <div class="method-signature">
 351          <span class="method-result"><a href="../System/IUser.html">IUser</a></span>
 352          <span class="method-name">
 353              getUser
 354          </span>
 355                  ()
 356              </div>
 357      
 358          
 359          
 360              <hr class="separator" />
 361          <div class="notes">Redefined in descendants as:</div>
 362          <ul class="redefinitions">
 363                      <li>
 364                  <a href="../System.Security/TUserManager.html#methodgetUser">TUserManager::getUser()</a>
 365                                  : Returns a user instance given the user name.
 366                              </li>
 367                  </ul>
 368      </div>
 369  <a name="methodpublishAsset" id="publishAsset"><!-- --></a>
 370  <div class="oddrow">
 371      
 372      <div class="method-header">
 373          <span class="method-title">publishAsset</span> (line <span class="line-number">93</span>)
 374      </div> 
 375      
 376      <!-- ========== Info from phpDoc block ========= -->
 377  <p class="short-description">Publishes a private asset and gets its URL.</p>
 378  <p class="description"><p>This method will publish a private asset (file or directory)  and gets the URL to the asset. Note, if the asset refers to  a directory, all contents under that directory will be published.</p></p>
 379      <ul class="tags">
 380                  <li><span class="field">return:</span> URL to the asset path.</li>
 381                  <li><span class="field">access:</span> public</li>
 382              </ul>
 383      
 384      <div class="method-signature">
 385          <span class="method-result">string</span>
 386          <span class="method-name">
 387              publishAsset
 388          </span>
 389                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$assetPath</span>)
 390              </div>
 391      
 392              <ul class="parameters">
 393                      <li>
 394                  <span class="var-type">string</span>
 395                  <span class="var-name">$assetPath</span><span class="var-description">: path of the asset that is relative to the directory containing the control class file.</span>            </li>
 396                  </ul>
 397          
 398          
 399      </div>
 400  <a name="methodpublishFilePath" id="publishFilePath"><!-- --></a>
 401  <div class="evenrow">
 402      
 403      <div class="method-header">
 404          <span class="method-title">publishFilePath</span> (line <span class="line-number">105</span>)
 405      </div> 
 406      
 407      <!-- ========== Info from phpDoc block ========= -->
 408  <p class="short-description">Publishes a file or directory and returns its URL.</p>
 409      <ul class="tags">
 410                  <li><span class="field">return:</span> URL to the published file or directory</li>
 411                  <li><span class="field">access:</span> public</li>
 412              </ul>
 413      
 414      <div class="method-signature">
 415          <span class="method-result">string</span>
 416          <span class="method-name">
 417              publishFilePath
 418          </span>
 419                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$fullPath</span>)
 420              </div>
 421      
 422              <ul class="parameters">
 423                      <li>
 424                  <span class="var-type">string</span>
 425                  <span class="var-name">$fullPath</span><span class="var-description">: absolute path of the file or directory to be published</span>            </li>
 426                  </ul>
 427          
 428          
 429              <hr class="separator" />
 430          <div class="notes">Redefined in descendants as:</div>
 431          <ul class="redefinitions">
 432                      <li>
 433                  <a href="../System.Web/TAssetManager.html#methodpublishFilePath">TAssetManager::publishFilePath()</a>
 434                                  : Publishes a file or a directory (recursively).
 435                              </li>
 436                  </ul>
 437      </div>
 438                              <h4>Inherited Methods</h4>
 439                  <a name='inherited_methods'><!-- --></a>    
 440                                      <!-- =========== Summary =========== -->
 441                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 442                      <blockquote>
 443                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 444                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 445                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 446                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 447                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 448                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 449                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 450                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 451                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 452                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 453                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 454                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 455                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 456                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 457                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 458                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 459                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 460                                              </blockquote>
 461                                          
 462          </div>
 463      </div>
 464  
 465  
 466      <p class="notes" id="credit">
 467          Documentation generated on Mon, 04 Dec 2006 11:25:52 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 468      </p>
 469      </div></body>
 470  </html>