[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 TAssetManager</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 TAssetManager</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">TAssetManager class</p>
  27  <p class="description"><p>TAssetManager provides a scheme to allow web clients visiting  private files that are normally web-inaccessible.</p><p>TAssetManager will copy the file to be published into a web-accessible  directory. The default base directory for storing the file is &quot;assets&quot;, which  should be under the application directory. This can be changed by setting  the <a href="../System.Web/TAssetManager.html#methodsetBasePath">BasePath</a> property together with the  <a href="../System.Web/TAssetManager.html#methodsetBaseUrl">BaseUrl</a> property that refers to the URL for accessing the base path.</p><p>By default, TAssetManager will not publish a file or directory if it already  exists in the publishing directory and has an older modification time.  If the application mode is set as 'Performance', the modification time check  will be skipped. You can explicitly require a modification time check  with the function <a href="../System.Web/TAssetManager.html#methodpublishFilePath">publishFilePath</a>. This is usually  very useful during development.</p><p>TAssetManager may be configured in application configuration file as follows,  <pre><ol><code><pre><li> &lt;<span class="src-id">module id</span>=<span class="src-str">&quot;asset&quot; </span><span class="src-id">BasePath</span>=<span class="src-str">&quot;Application.assets&quot; </span><span class="src-id">BaseUrl</span>=<span class="src-str">&quot;/assets&quot; </span>/&gt;</li>
  28  </pre></code></ol></pre>  where <a href="../System.Web/TAssetManager.html#methodgetBasePath">BasePath</a> and <a href="../System.Web/TAssetManager.html#methodgetBaseUrl">BaseUrl</a> are  configurable properties of TAssetManager. Make sure that BasePath is a namespace  pointing to a valid directory writable by the Web server process.</p></p>
  29      <ul class="tags">
  30                  <li><span class="field">since:</span> 3.0</li>
  31                  <li><span class="field">version:</span> $Id: TAssetManager.php 1546 2006-12-03 22:44:38Z wei $</li>
  32                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  33              </ul>
  34          <p class="notes">
  35              Located in <a class="field" href="_Web_TAssetManager_php.html">/Web/TAssetManager.php</a> (line <span class="field">45</span>)
  36          </p>
  37          
  38                  
  39          <pre><a href="../System/TComponent.html">TComponent</a>
  40     |
  41     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  42        |
  43        --<a href="../System/TModule.html">TModule</a>
  44           |
  45           --TAssetManager</pre>
  46      
  47              </div>
  48  </div>
  49  
  50  
  51      <a name="sec-const-summary"></a>
  52      <div class="info-box">
  53          <div class="info-box-title">Class Constant Summary</span></div>
  54          <div class="nav-bar">
  55              <a href="#sec-description">Description</a> |
  56                          <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  57                                          | 
  58                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  59                              
  60                      </div>
  61          <div class="info-box-body">
  62              <div class="const-summary">
  63                                  <div class="const-title">
  64                      <img src="../media/images/Constant.png" alt=" " />
  65                      <a href="#DEFAULT_BASEPATH" title="details" class="const-name">DEFAULT_BASEPATH</a> =                     <span class="var-type">'assets'</span>
  66  
  67                  </div>
  68                              </div>
  69          </div>
  70      </div>
  71  
  72  
  73      <a name="sec-method-summary"></a>
  74      <div class="info-box">
  75          <div class="info-box-title">Method Summary</span></div>
  76          <div class="nav-bar">
  77              <a href="#sec-description">Description</a> |
  78                                                              <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  79                              
  80                                      <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  81          </div>
  82          <div class="info-box-body">            
  83              <div class="method-summary">
  84                                  
  85                  <div class="method-definition">
  86                                              <span class="method-result">void</span>
  87                                          <a href="#copyDirectory" title="details" class="method-name">copyDirectory</a>
  88                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$src</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dst</span>)
  89                                      </div>
  90                                  
  91                  <div class="method-definition">
  92                                              <span class="method-result">void</span>
  93                                          <a href="#copyFile" title="details" class="method-name">copyFile</a>
  94                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$src</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dst</span>)
  95                                      </div>
  96                                  
  97                  <div class="method-definition">
  98                                              <span class="method-result">boolean</span>
  99                                          <a href="#deployTarFile" title="details" class="method-name">deployTarFile</a>
 100                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span>)
 101                                      </div>
 102                                  
 103                  <div class="method-definition">
 104                                              <span class="method-result">string</span>
 105                                          <a href="#getBasePath" title="details" class="method-name">getBasePath</a>
 106                                          ()
 107                                      </div>
 108                                  
 109                  <div class="method-definition">
 110                                              <span class="method-result">string</span>
 111                                          <a href="#getBaseUrl" title="details" class="method-name">getBaseUrl</a>
 112                                          ()
 113                                      </div>
 114                                  
 115                  <div class="method-definition">
 116                                              <span class="method-result">string</span>
 117                                          <a href="#getPublishedPath" title="details" class="method-name">getPublishedPath</a>
 118                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
 119                                      </div>
 120                                  
 121                  <div class="method-definition">
 122                                              <span class="method-result">string</span>
 123                                          <a href="#getPublishedUrl" title="details" class="method-name">getPublishedUrl</a>
 124                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
 125                                      </div>
 126                                  
 127                  <div class="method-definition">
 128                                              <span class="method-result">string</span>
 129                                          <a href="#hash" title="details" class="method-name">hash</a>
 130                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
 131                                      </div>
 132                                  
 133                  <div class="method-definition">
 134                                              <span class="method-result">void</span>
 135                                          <a href="#init" title="details" class="method-name">init</a>
 136                                              (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 137                                      </div>
 138                                  
 139                  <div class="method-definition">
 140                                              <span class="method-result">string</span>
 141                                          <a href="#publishFilePath" title="details" class="method-name">publishFilePath</a>
 142                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checkTimestamp</span> = <span class="var-default">false</span>])
 143                                      </div>
 144                                  
 145                  <div class="method-definition">
 146                                              <span class="method-result">string</span>
 147                                          <a href="#publishTarFile" title="details" class="method-name">publishTarFile</a>
 148                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$tarfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$md5sum</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$checkTimestamp</span> = <span class="var-default">false</span>])
 149                                      </div>
 150                                  
 151                  <div class="method-definition">
 152                                              <span class="method-result">void</span>
 153                                          <a href="#setBasePath" title="details" class="method-name">setBasePath</a>
 154                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 155                                      </div>
 156                                  
 157                  <div class="method-definition">
 158                                              <span class="method-result">void</span>
 159                                          <a href="#setBaseUrl" title="details" class="method-name">setBaseUrl</a>
 160                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 161                                      </div>
 162                              </div>
 163          </div>
 164      </div>        
 165  
 166      
 167      <a name="sec-methods"></a>
 168      <div class="info-box">
 169          <div class="info-box-title">Methods</div>
 170          <div class="nav-bar">
 171              <a href="#sec-description">Description</a> |
 172                                                                          <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
 173                              
 174                                          <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 175                          
 176          </div>
 177          <div class="info-box-body">
 178              <A NAME='method_detail'></A>
 179  <a name="methodcopyDirectory" id="copyDirectory"><!-- --></a>
 180  <div class="oddrow">
 181      
 182      <div class="method-header">
 183          <span class="method-title">copyDirectory</span> (line <span class="line-number">254</span>)
 184      </div> 
 185      
 186      <!-- ========== Info from phpDoc block ========= -->
 187  <p class="short-description">Copies a directory recursively as another.</p>
 188  <p class="description"><p>If the destination directory does not exist, it will be created.  File modification time is used to ensure the copied files are latest.</p></p>
 189      <ul class="tags">
 190                  <li><span class="field">access:</span> public</li>
 191                  <li><span class="field">todo:</span> a generic solution to ignore certain directories and files</li>
 192              </ul>
 193      
 194      <div class="method-signature">
 195          <span class="method-result">void</span>
 196          <span class="method-name">
 197              copyDirectory
 198          </span>
 199                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$src</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dst</span>)
 200              </div>
 201      
 202              <ul class="parameters">
 203                      <li>
 204                  <span class="var-type">string</span>
 205                  <span class="var-name">$src</span><span class="var-description">: the source directory</span>            </li>
 206                      <li>
 207                  <span class="var-type">string</span>
 208                  <span class="var-name">$dst</span><span class="var-description">: the destination directory</span>            </li>
 209                  </ul>
 210          
 211          
 212      </div>
 213  <a name="methodcopyFile" id="copyFile"><!-- --></a>
 214  <div class="evenrow">
 215      
 216      <div class="method-header">
 217          <span class="method-title">copyFile</span> (line <span class="line-number">231</span>)
 218      </div> 
 219      
 220      <!-- ========== Info from phpDoc block ========= -->
 221  <p class="short-description">Copies a file to a directory.</p>
 222  <p class="description"><p>Copying is done only when the destination file does not exist  or has an older file modification time.</p></p>
 223      <ul class="tags">
 224                  <li><span class="field">access:</span> protected</li>
 225              </ul>
 226      
 227      <div class="method-signature">
 228          <span class="method-result">void</span>
 229          <span class="method-name">
 230              copyFile
 231          </span>
 232                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$src</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dst</span>)
 233              </div>
 234      
 235              <ul class="parameters">
 236                      <li>
 237                  <span class="var-type">string</span>
 238                  <span class="var-name">$src</span><span class="var-description">: source file path</span>            </li>
 239                      <li>
 240                  <span class="var-type">string</span>
 241                  <span class="var-name">$dst</span><span class="var-description">: destination directory (if not exists, it will be created)</span>            </li>
 242                  </ul>
 243          
 244          
 245      </div>
 246  <a name="methoddeployTarFile" id="deployTarFile"><!-- --></a>
 247  <div class="oddrow">
 248      
 249      <div class="method-header">
 250          <span class="method-title">deployTarFile</span> (line <span class="line-number">317</span>)
 251      </div> 
 252      
 253      <!-- ========== Info from phpDoc block ========= -->
 254  <p class="short-description">Extracts the tar file to the destination directory.</p>
 255  <p class="description"><p>N.B Tar file must not be compressed.</p></p>
 256      <ul class="tags">
 257                  <li><span class="field">return:</span> true if extract successful, false otherwise.</li>
 258                  <li><span class="field">access:</span> protected</li>
 259              </ul>
 260      
 261      <div class="method-signature">
 262          <span class="method-result">boolean</span>
 263          <span class="method-name">
 264              deployTarFile
 265          </span>
 266                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span>)
 267              </div>
 268      
 269              <ul class="parameters">
 270                      <li>
 271                  <span class="var-type">string</span>
 272                  <span class="var-name">$path</span><span class="var-description">: tar file</span>            </li>
 273                      <li>
 274                  <span class="var-type">string</span>
 275                  <span class="var-name">$destination</span><span class="var-description">: path where the contents of tar file are to be extracted</span>            </li>
 276                  </ul>
 277          
 278          
 279      </div>
 280  <a name="methodgetBasePath" id="getBasePath"><!-- --></a>
 281  <div class="evenrow">
 282      
 283      <div class="method-header">
 284          <span class="method-title">getBasePath</span> (line <span class="line-number">97</span>)
 285      </div> 
 286      
 287      <!-- ========== Info from phpDoc block ========= -->
 288      <ul class="tags">
 289                  <li><span class="field">return:</span> the root directory storing published asset files</li>
 290                  <li><span class="field">access:</span> public</li>
 291              </ul>
 292      
 293      <div class="method-signature">
 294          <span class="method-result">string</span>
 295          <span class="method-name">
 296              getBasePath
 297          </span>
 298                  ()
 299              </div>
 300      
 301          
 302          
 303      </div>
 304  <a name="methodgetBaseUrl" id="getBaseUrl"><!-- --></a>
 305  <div class="oddrow">
 306      
 307      <div class="method-header">
 308          <span class="method-title">getBaseUrl</span> (line <span class="line-number">123</span>)
 309      </div> 
 310      
 311      <!-- ========== Info from phpDoc block ========= -->
 312      <ul class="tags">
 313                  <li><span class="field">return:</span> the base url that the published asset files can be accessed</li>
 314                  <li><span class="field">access:</span> public</li>
 315              </ul>
 316      
 317      <div class="method-signature">
 318          <span class="method-result">string</span>
 319          <span class="method-name">
 320              getBaseUrl
 321          </span>
 322                  ()
 323              </div>
 324      
 325          
 326          
 327      </div>
 328  <a name="methodgetPublishedPath" id="getPublishedPath"><!-- --></a>
 329  <div class="evenrow">
 330      
 331      <div class="method-header">
 332          <span class="method-title">getPublishedPath</span> (line <span class="line-number">188</span>)
 333      </div> 
 334      
 335      <!-- ========== Info from phpDoc block ========= -->
 336  <p class="short-description">Returns the published path of a file path.</p>
 337  <p class="description"><p>This method does not perform any publishing. It merely tells you  if the file path is published, where it will go.</p></p>
 338      <ul class="tags">
 339                  <li><span class="field">return:</span> the published file path</li>
 340                  <li><span class="field">access:</span> public</li>
 341              </ul>
 342      
 343      <div class="method-signature">
 344          <span class="method-result">string</span>
 345          <span class="method-name">
 346              getPublishedPath
 347          </span>
 348                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
 349              </div>
 350      
 351              <ul class="parameters">
 352                      <li>
 353                  <span class="var-type">string</span>
 354                  <span class="var-name">$path</span><span class="var-description">: directory or file path being published</span>            </li>
 355                  </ul>
 356          
 357          
 358      </div>
 359  <a name="methodgetPublishedUrl" id="getPublishedUrl"><!-- --></a>
 360  <div class="oddrow">
 361      
 362      <div class="method-header">
 363          <span class="method-title">getPublishedUrl</span> (line <span class="line-number">204</span>)
 364      </div> 
 365      
 366      <!-- ========== Info from phpDoc block ========= -->
 367  <p class="short-description">Returns the URL of a published file path.</p>
 368  <p class="description"><p>This method does not perform any publishing. It merely tells you  if the file path is published, what the URL will be to access it.</p></p>
 369      <ul class="tags">
 370                  <li><span class="field">return:</span> the published URL for the file path</li>
 371                  <li><span class="field">access:</span> public</li>
 372              </ul>
 373      
 374      <div class="method-signature">
 375          <span class="method-result">string</span>
 376          <span class="method-name">
 377              getPublishedUrl
 378          </span>
 379                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
 380              </div>
 381      
 382              <ul class="parameters">
 383                      <li>
 384                  <span class="var-type">string</span>
 385                  <span class="var-name">$path</span><span class="var-description">: directory or file path being published</span>            </li>
 386                  </ul>
 387          
 388          
 389      </div>
 390  <a name="methodhash" id="hash"><!-- --></a>
 391  <div class="evenrow">
 392      
 393      <div class="method-header">
 394          <span class="method-title">hash</span> (line <span class="line-number">219</span>)
 395      </div> 
 396      
 397      <!-- ========== Info from phpDoc block ========= -->
 398  <p class="short-description">Generate a CRC32 hash for the directory path. Collisions are higher  than MD5 but generates a much smaller hash string.</p>
 399      <ul class="tags">
 400                  <li><span class="field">return:</span> hashed string.</li>
 401                  <li><span class="field">access:</span> protected</li>
 402              </ul>
 403      
 404      <div class="method-signature">
 405          <span class="method-result">string</span>
 406          <span class="method-name">
 407              hash
 408          </span>
 409                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
 410              </div>
 411      
 412              <ul class="parameters">
 413                      <li>
 414                  <span class="var-type">string</span>
 415                  <span class="var-name">$dir</span><span class="var-description">: string to be hashed.</span>            </li>
 416                  </ul>
 417          
 418          
 419      </div>
 420  <a name="methodinit" id="init"><!-- --></a>
 421  <div class="oddrow">
 422      
 423      <div class="method-header">
 424          <span class="method-title">init</span> (line <span class="line-number">81</span>)
 425      </div> 
 426      
 427      <!-- ========== Info from phpDoc block ========= -->
 428  <p class="short-description">Initializes the module.</p>
 429  <p class="description"><p>This method is required by IModule and is invoked by application.</p></p>
 430      <ul class="tags">
 431                  <li><span class="field">access:</span> public</li>
 432              </ul>
 433      
 434      <div class="method-signature">
 435          <span class="method-result">void</span>
 436          <span class="method-name">
 437              init
 438          </span>
 439                      (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 440              </div>
 441      
 442              <ul class="parameters">
 443                      <li>
 444                  <span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>
 445                  <span class="var-name">$config</span><span class="var-description">: module configuration</span>            </li>
 446                  </ul>
 447          
 448              <hr class="separator" />
 449          <div class="notes">Redefinition of:</div>
 450          <dl>
 451              <dt><a href="../System/TModule.html#methodinit">TModule::init()</a></dt>
 452                          <dd>Initializes the module.</dd>
 453                      </dl>
 454          
 455      </div>
 456  <a name="methodpublishFilePath" id="publishFilePath"><!-- --></a>
 457  <div class="evenrow">
 458      
 459      <div class="method-header">
 460          <span class="method-title">publishFilePath</span> (line <span class="line-number">154</span>)
 461      </div> 
 462      
 463      <!-- ========== Info from phpDoc block ========= -->
 464  <p class="short-description">Publishes a file or a directory (recursively).</p>
 465  <p class="description"><p>This method will copy the content in a directory (recursively) to  a web accessible directory and returns the URL for the directory.  If the application is not in performance mode, the file modification  time will be used to make sure the published file is latest or not.  If not, a file copy will be performed.</p></p>
 466      <ul class="tags">
 467                  <li><span class="field">return:</span> an absolute URL to the published directory</li>
 468                  <li><span class="field">access:</span> public</li>
 469                  <li><span class="field">throws:</span> TInvalidDataValueException if the file path to be published is  invalid</li>
 470              </ul>
 471      
 472      <div class="method-signature">
 473          <span class="method-result">string</span>
 474          <span class="method-name">
 475              publishFilePath
 476          </span>
 477                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$checkTimestamp</span> = <span class="var-default">false</span>])
 478              </div>
 479      
 480              <ul class="parameters">
 481                      <li>
 482                  <span class="var-type">string</span>
 483                  <span class="var-name">$path</span><span class="var-description">: the path to be published</span>            </li>
 484                      <li>
 485                  <span class="var-type">boolean</span>
 486                  <span class="var-name">$checkTimestamp</span><span class="var-description">: If true, file modification time will be checked even if the application  is in performance mode.</span>            </li>
 487                  </ul>
 488          
 489              <hr class="separator" />
 490          <div class="notes">Redefinition of:</div>
 491          <dl>
 492              <dt><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></dt>
 493                          <dd>Publishes a file or directory and returns its URL.</dd>
 494                      </dl>
 495          
 496      </div>
 497  <a name="methodpublishTarFile" id="publishTarFile"><!-- --></a>
 498  <div class="oddrow">
 499      
 500      <div class="method-header">
 501          <span class="method-title">publishTarFile</span> (line <span class="line-number">287</span>)
 502      </div> 
 503      
 504      <!-- ========== Info from phpDoc block ========= -->
 505  <p class="short-description">Publish a tar file by extracting its contents to the assets directory.</p>
 506  <p class="description"><p>Each tar file must be accomplished with its own MD5 check sum file.  The MD5 file is published when the tar contents are successfully  extracted to the assets directory. The presence of the MD5 file  as published asset assumes that the tar file has already been extracted.</p></p>
 507      <ul class="tags">
 508                  <li><span class="field">return:</span> URL path to the directory where the tar file was extracted.</li>
 509                  <li><span class="field">access:</span> public</li>
 510              </ul>
 511      
 512      <div class="method-signature">
 513          <span class="method-result">string</span>
 514          <span class="method-name">
 515              publishTarFile
 516          </span>
 517                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$tarfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$md5sum</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$checkTimestamp</span> = <span class="var-default">false</span>])
 518              </div>
 519      
 520              <ul class="parameters">
 521                      <li>
 522                  <span class="var-type">string</span>
 523                  <span class="var-name">$tarfile</span><span class="var-description">: tar filename</span>            </li>
 524                      <li>
 525                  <span class="var-type">string</span>
 526                  <span class="var-name">$md5sum</span><span class="var-description">: MD5 checksum for the corresponding tar file.</span>            </li>
 527                  </ul>
 528          
 529          
 530      </div>
 531  <a name="methodsetBasePath" id="setBasePath"><!-- --></a>
 532  <div class="evenrow">
 533      
 534      <div class="method-header">
 535          <span class="method-title">setBasePath</span> (line <span class="line-number">108</span>)
 536      </div> 
 537      
 538      <!-- ========== Info from phpDoc block ========= -->
 539  <p class="short-description">Sets the root directory storing published asset files.</p>
 540  <p class="description"><p>The directory must be in namespace format.</p></p>
 541      <ul class="tags">
 542                  <li><span class="field">access:</span> public</li>
 543                  <li><span class="field">throws:</span> TInvalidOperationException if the module is initialized already</li>
 544              </ul>
 545      
 546      <div class="method-signature">
 547          <span class="method-result">void</span>
 548          <span class="method-name">
 549              setBasePath
 550          </span>
 551                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 552              </div>
 553      
 554              <ul class="parameters">
 555                      <li>
 556                  <span class="var-type">string</span>
 557                  <span class="var-name">$value</span><span class="var-description">: the root directory storing published asset files</span>            </li>
 558                  </ul>
 559          
 560          
 561      </div>
 562  <a name="methodsetBaseUrl" id="setBaseUrl"><!-- --></a>
 563  <div class="oddrow">
 564      
 565      <div class="method-header">
 566          <span class="method-title">setBaseUrl</span> (line <span class="line-number">132</span>)
 567      </div> 
 568      
 569      <!-- ========== Info from phpDoc block ========= -->
 570      <ul class="tags">
 571                  <li><span class="field">access:</span> public</li>
 572                  <li><span class="field">throws:</span> TInvalidOperationException if the module is initialized already</li>
 573              </ul>
 574      
 575      <div class="method-signature">
 576          <span class="method-result">void</span>
 577          <span class="method-name">
 578              setBaseUrl
 579          </span>
 580                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 581              </div>
 582      
 583              <ul class="parameters">
 584                      <li>
 585                  <span class="var-type">string</span>
 586                  <span class="var-name">$value</span><span class="var-description">: the base url that the published asset files can be accessed</span>            </li>
 587                  </ul>
 588          
 589          
 590      </div>
 591                              <h4>Inherited Methods</h4>
 592                  <a name='inherited_methods'><!-- --></a>    
 593                                      <!-- =========== Summary =========== -->
 594                      <p>Inherited From <span class="classname"><a href="../System/TModule.html">TModule</a></span></p>
 595                      <blockquote>
 596                                                      <span class="method-name"><a href="../System/TModule.html#methodgetID">TModule::getID()</a></span><br>
 597                                                      <span class="method-name"><a href="../System/TModule.html#methodinit">TModule::init()</a></span><br>
 598                                                      <span class="method-name"><a href="../System/TModule.html#methodsetID">TModule::setID()</a></span><br>
 599                                              </blockquote>
 600                                      <!-- =========== Summary =========== -->
 601                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 602                      <blockquote>
 603                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 604                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 605                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 606                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 607                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 608                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 609                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 610                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 611                                              </blockquote>
 612                                      <!-- =========== Summary =========== -->
 613                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 614                      <blockquote>
 615                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 616                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 617                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 618                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 619                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 620                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 621                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 622                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 623                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 624                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 625                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 626                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 627                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 628                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 629                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 630                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 631                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 632                                              </blockquote>
 633                                          
 634          </div>
 635      </div>
 636  
 637      <a name="sec-consts"></a>
 638      <div class="info-box">
 639          <div class="info-box-title">Class Constants</div>
 640          <div class="nav-bar">
 641              <a href="#sec-description">Description</a> |
 642                                          <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
 643                          
 644              
 645                                          | 
 646                                      <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 647                              
 648                      </div>
 649          <div class="info-box-body">
 650              <a name="constDEFAULT_BASEPATH" id="DEFAULT_BASEPATH"><!-- --></A>
 651  <div class="evenrow">
 652  
 653      <div class="const-header">
 654          <img src="../media/images/Variable.png" />
 655          <span class="const-title">
 656              <span class="const-name">DEFAULT_BASEPATH</span>
 657               = <span class="const-default">'assets'</span>
 658              (line <span class="line-number">50</span>)
 659          </span>
 660      </div>
 661  
 662      <!-- ========== Info from phpDoc block ========= -->
 663  <p class="short-description">Default web accessible base path for storing private files</p>
 664      
 665      
 666  </div>
 667  
                        
 668          </div>
 669      </div>
 670  
 671      <p class="notes" id="credit">
 672          Documentation generated on Mon, 04 Dec 2006 11:25:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 673      </p>
 674      </div></body>
 675  </html>