[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 TUrlManager</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 TUrlManager</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">TUrlManager class</p>
  26  <p class="description"><p>TUrlManager is the base class for managing URLs that can be  recognized by PRADO applications. It provides the default implementation  for parsing and constructing URLs.</p><p>Derived classes may override <a href="../System.Web/TUrlManager.html#methodconstructUrl">constructUrl</a> and <a href="../System.Web/TUrlManager.html#methodparseUrl">parseUrl</a>  to provide customized URL schemes.</p><p>By default, <a href="../System.Web/THttpRequest.html">THttpRequest</a> uses TUrlManager as its URL manager.  If you want to use your customized URL manager, load your manager class  as an application module and set THttpRequest::setUrlManager  with the ID of your URL manager module.</p></p>
  27      <ul class="tags">
  28                  <li><span class="field">since:</span> 3.0.6</li>
  29                  <li><span class="field">version:</span> $Id $</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="_Web_TUrlManager_php.html">/Web/TUrlManager.php</a> (line <span class="field">33</span>)
  34          </p>
  35          
  36                  
  37          <pre><a href="../System/TComponent.html">TComponent</a>
  38     |
  39     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  40        |
  41        --<a href="../System/TModule.html">TModule</a>
  42           |
  43           --TUrlManager</pre>
  44      
  45              </div>
  46  </div>
  47  
  48      <a name="sec-descendents"></a>
  49      <div class="info-box">
  50          <div class="info-box-title">Direct descendents</div>
  51          <div class="nav-bar">
  52              <a href="#sec-description">Description</a> |
  53              <span class="disabled">Descendents</span>
  54              |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  55                              
  56                                  </div>
  57          <div class="info-box-body">
  58              <table cellpadding="2" cellspacing="0" class="class-table">
  59                  <tr>
  60                      <th class="class-table-header">Class</th>
  61                      <th class="class-table-header">Description</th>
  62                  </tr>
  63                                  <tr>
  64                      <td style="padding-right: 2em"><a href="../System.Web/TUrlMapping.html">TUrlMapping</a></td>
  65                      <td>
  66                                              TUrlMapping Class
  67                                          </td>
  68                  </tr>
  69                              </table>
  70          </div>
  71      </div>
  72  
  73  
  74  
  75      <a name="sec-method-summary"></a>
  76      <div class="info-box">
  77          <div class="info-box-title">Method Summary</span></div>
  78          <div class="nav-bar">
  79              <a href="#sec-description">Description</a> |
  80                              <a href="#sec-descendents">Descendents</a> |
  81                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  82          </div>
  83          <div class="info-box-body">            
  84              <div class="method-summary">
  85                                  
  86                  <div class="method-definition">
  87                                              <span class="method-result">string</span>
  88                                          <a href="#constructUrl" title="details" class="method-name">constructUrl</a>
  89                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceID</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$serviceParam</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$getItems</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$encodeAmpersand</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$encodeGetItems</span>)
  90                                      </div>
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">array</span>
  94                                          <a href="#parseUrl" title="details" class="method-name">parseUrl</a>
  95                                          ()
  96                                      </div>
  97                              </div>
  98          </div>
  99      </div>        
 100  
 101      
 102      <a name="sec-methods"></a>
 103      <div class="info-box">
 104          <div class="info-box-title">Methods</div>
 105          <div class="nav-bar">
 106              <a href="#sec-description">Description</a> |
 107                              <a href="#sec-descendents">Descendents</a> |
 108                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 109                          
 110          </div>
 111          <div class="info-box-body">
 112              <A NAME='method_detail'></A>
 113  <a name="methodconstructUrl" id="constructUrl"><!-- --></a>
 114  <div class="oddrow">
 115      
 116      <div class="method-header">
 117          <span class="method-title">constructUrl</span> (line <span class="line-number">55</span>)
 118      </div> 
 119      
 120      <!-- ========== Info from phpDoc block ========= -->
 121  <p class="short-description">Constructs a URL that can be recognized by PRADO.</p>
 122  <p class="description"><p>This method provides the actual implementation used by THttpRequest::constructUrl.  Override this method if you want to provide your own way of URL formatting.  If you do so, you may also need to override <a href="../System.Web/TUrlManager.html#methodparseUrl">parseUrl</a> so that the URL can be properly parsed.</p><p>The URL is constructed as the following format:  /entryscript.php?serviceID=serviceParameter&amp;get1=value1&amp;...  If THttpRequest::setUrlFormat is 'Path',  the following format is used instead:  /entryscript.php/serviceID/serviceParameter/get1,value1/get2,value2...</p></p>
 123      <ul class="tags">
 124                  <li><span class="field">return:</span> URL</li>
 125                  <li><span class="field">access:</span> public</li>
 126                  <li><span class="field">see:</span> <a href="../System.Web/TUrlManager.html#methodparseUrl">TUrlManager::parseUrl()</a></li>
 127              </ul>
 128      
 129      <div class="method-signature">
 130          <span class="method-result">string</span>
 131          <span class="method-name">
 132              constructUrl
 133          </span>
 134                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$serviceID</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$serviceParam</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$getItems</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$encodeAmpersand</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$encodeGetItems</span>)
 135              </div>
 136      
 137              <ul class="parameters">
 138                      <li>
 139                  <span class="var-type">string</span>
 140                  <span class="var-name">$serviceID</span><span class="var-description">: service ID</span>            </li>
 141                      <li>
 142                  <span class="var-type">string</span>
 143                  <span class="var-name">$serviceParam</span><span class="var-description">: service parameter</span>            </li>
 144                      <li>
 145                  <span class="var-type">array</span>
 146                  <span class="var-name">$getItems</span><span class="var-description">: GET parameters, null if not provided</span>            </li>
 147                      <li>
 148                  <span class="var-type">boolean</span>
 149                  <span class="var-name">$encodeAmpersand</span><span class="var-description">: whether to encode the ampersand in URL</span>            </li>
 150                      <li>
 151                  <span class="var-type">boolean</span>
 152                  <span class="var-name">$encodeGetItems</span><span class="var-description">: whether to encode the GET parameters (their names and values)</span>            </li>
 153                  </ul>
 154          
 155          
 156      </div>
 157  <a name="methodparseUrl" id="parseUrl"><!-- --></a>
 158  <div class="evenrow">
 159      
 160      <div class="method-header">
 161          <span class="method-title">parseUrl</span> (line <span class="line-number">109</span>)
 162      </div> 
 163      
 164      <!-- ========== Info from phpDoc block ========= -->
 165  <p class="short-description">Parses the request URL and returns an array of input parameters.</p>
 166  <p class="description"><p>This mehtod is automatically invoked by <a href="../System.Web/THttpRequest.html">THttpRequest</a> when  handling a user request.</p><p>In general, this method should parse the path info part of the requesting URL  and generate an array of name-value pairs according to some scheme.  The current implementation deals with both 'Get' and 'Path' URL formats.</p><p>You may override this method to support customized URL format.</p></p>
 167      <ul class="tags">
 168                  <li><span class="field">return:</span> list of input parameters, indexed by parameter names</li>
 169                  <li><span class="field">access:</span> public</li>
 170                  <li><span class="field">see:</span> <a href="../System.Web/TUrlManager.html#methodconstructUrl">TUrlManager::constructUrl()</a></li>
 171              </ul>
 172      
 173      <div class="method-signature">
 174          <span class="method-result">array</span>
 175          <span class="method-name">
 176              parseUrl
 177          </span>
 178                  ()
 179              </div>
 180      
 181          
 182          
 183              <hr class="separator" />
 184          <div class="notes">Redefined in descendants as:</div>
 185          <ul class="redefinitions">
 186                      <li>
 187                  <a href="../System.Web/TUrlMapping.html#methodparseUrl">TUrlMapping::parseUrl()</a>
 188                                  : Parses the request URL and returns an array of input parameters.
 189                              </li>
 190                  </ul>
 191      </div>
 192                              <h4>Inherited Methods</h4>
 193                  <a name='inherited_methods'><!-- --></a>    
 194                                      <!-- =========== Summary =========== -->
 195                      <p>Inherited From <span class="classname"><a href="../System/TModule.html">TModule</a></span></p>
 196                      <blockquote>
 197                                                      <span class="method-name"><a href="../System/TModule.html#methodgetID">TModule::getID()</a></span><br>
 198                                                      <span class="method-name"><a href="../System/TModule.html#methodinit">TModule::init()</a></span><br>
 199                                                      <span class="method-name"><a href="../System/TModule.html#methodsetID">TModule::setID()</a></span><br>
 200                                              </blockquote>
 201                                      <!-- =========== Summary =========== -->
 202                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 203                      <blockquote>
 204                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 205                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 206                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 207                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 208                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 209                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 210                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 211                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 212                                              </blockquote>
 213                                      <!-- =========== Summary =========== -->
 214                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 215                      <blockquote>
 216                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 217                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 218                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 219                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 220                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 221                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 222                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 223                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 224                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 225                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 226                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 227                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 228                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 229                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 230                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 231                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 232                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 233                                              </blockquote>
 234                                          
 235          </div>
 236      </div>
 237  
 238  
 239      <p class="notes" id="credit">
 240          Documentation generated on Mon, 04 Dec 2006 11:27:48 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 241      </p>
 242      </div></body>
 243  </html>