[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 TPagedListIterator</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 TPagedListIterator</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                      </div>
  22      <div class="info-box-body">
  23                  <p class="implements">
  24              Implements interfaces:
  25              <ul>
  26                  <li></li>            </ul>
  27          </p>
  28                  <!-- ========== Info from phpDoc block ========= -->
  29  <p class="short-description">TPagedListIterator class</p>
  30  <p class="description"><p>TPagedListIterator implements Iterator interface.</p><p>TPagedListIterator is used by <a href="../System.Collections/TPagedDataSource.html">TPagedDataSource</a>. It allows TPagedDataSource  to return a new iterator for traversing the items in a <a href="../System.Collections/TList.html">TList</a> object.</p></p>
  31      <ul class="tags">
  32                  <li><span class="field">since:</span> 3.0</li>
  33                  <li><span class="field">version:</span> $Id: TPagedDataSource.php 1397 2006-09-07 07:55:53Z wei $</li>
  34                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  35              </ul>
  36          <p class="notes">
  37              Located in <a class="field" href="_Collections_TPagedDataSource_php.html">/Collections/TPagedDataSource.php</a> (line <span class="field">284</span>)
  38          </p>
  39          
  40                  
  41          <pre></pre>
  42      
  43              </div>
  44  </div>
  45  
  46  
  47  
  48  
  49      <a name="sec-method-summary"></a>
  50      <div class="info-box">
  51          <div class="info-box-title">Method Summary</span></div>
  52          <div class="nav-bar">
  53              <a href="#sec-description">Description</a> |
  54                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  55          </div>
  56          <div class="info-box-body">            
  57              <div class="method-summary">
  58                                  
  59                  <div class="method-definition">
  60                                              <span class="method-result">TPagedListIterator</span>
  61                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  62                                              (<span class="var-type">TList</span>&nbsp;<span class="var-name">$list</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$startIndex</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$count</span>)
  63                                      </div>
  64                                  
  65                  <div class="method-definition">
  66                                              <span class="method-result">mixed</span>
  67                                          <a href="#current" title="details" class="method-name">current</a>
  68                                          ()
  69                                      </div>
  70                                  
  71                  <div class="method-definition">
  72                                              <span class="method-result">integer</span>
  73                                          <a href="#key" title="details" class="method-name">key</a>
  74                                          ()
  75                                      </div>
  76                                  
  77                  <div class="method-definition">
  78                                              <span class="method-result">void</span>
  79                                          <a href="#next" title="details" class="method-name">next</a>
  80                                          ()
  81                                      </div>
  82                                  
  83                  <div class="method-definition">
  84                                              <span class="method-result">void</span>
  85                                          <a href="#rewind" title="details" class="method-name">rewind</a>
  86                                          ()
  87                                      </div>
  88                                  
  89                  <div class="method-definition">
  90                                              <span class="method-result">boolean</span>
  91                                          <a href="#valid" title="details" class="method-name">valid</a>
  92                                          ()
  93                                      </div>
  94                              </div>
  95          </div>
  96      </div>        
  97  
  98      
  99      <a name="sec-methods"></a>
 100      <div class="info-box">
 101          <div class="info-box-title">Methods</div>
 102          <div class="nav-bar">
 103              <a href="#sec-description">Description</a> |
 104                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 105                          
 106          </div>
 107          <div class="info-box-body">
 108              <A NAME='method_detail'></A>
 109  <a name="method__construct" id="__construct"><!-- --></a>
 110  <div class="oddrow">
 111      
 112      <div class="method-header">
 113          <span class="method-title">Constructor __construct</span> (line <span class="line-number">297</span>)
 114      </div> 
 115      
 116      <!-- ========== Info from phpDoc block ========= -->
 117  <p class="short-description">Constructor.</p>
 118      <ul class="tags">
 119                  <li><span class="field">access:</span> public</li>
 120              </ul>
 121      
 122      <div class="method-signature">
 123          <span class="method-result">TPagedListIterator</span>
 124          <span class="method-name">
 125              __construct
 126          </span>
 127                      (<span class="var-type">TList</span>&nbsp;<span class="var-name">$list</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$startIndex</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$count</span>)
 128              </div>
 129      
 130              <ul class="parameters">
 131                      <li>
 132                  <span class="var-type"><a href="../System.Collections/TList.html">TList</a></span>
 133                  <span class="var-name">$list</span><span class="var-description">: the data to be iterated through</span>            </li>
 134                      <li>
 135                  <span class="var-type">integer</span>
 136                  <span class="var-name">$startIndex</span><span class="var-description">: start index</span>            </li>
 137                      <li>
 138                  <span class="var-type">integer</span>
 139                  <span class="var-name">$count</span><span class="var-description">: number of items to be iterated through</span>            </li>
 140                  </ul>
 141          
 142          
 143      </div>
 144  <a name="methodcurrent" id="current"><!-- --></a>
 145  <div class="evenrow">
 146      
 147      <div class="method-header">
 148          <span class="method-title">current</span> (line <span class="line-number">332</span>)
 149      </div> 
 150      
 151      <!-- ========== Info from phpDoc block ========= -->
 152  <p class="short-description">Returns the current array item.</p>
 153  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 154      <ul class="tags">
 155                  <li><span class="field">return:</span> the current array item</li>
 156                  <li><span class="field">access:</span> public</li>
 157              </ul>
 158      
 159      <div class="method-signature">
 160          <span class="method-result">mixed</span>
 161          <span class="method-name">
 162              current
 163          </span>
 164                  ()
 165              </div>
 166      
 167          
 168          
 169      </div>
 170  <a name="methodkey" id="key"><!-- --></a>
 171  <div class="oddrow">
 172      
 173      <div class="method-header">
 174          <span class="method-title">key</span> (line <span class="line-number">322</span>)
 175      </div> 
 176      
 177      <!-- ========== Info from phpDoc block ========= -->
 178  <p class="short-description">Returns the key of the current array item.</p>
 179  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 180      <ul class="tags">
 181                  <li><span class="field">return:</span> the key of the current array item</li>
 182                  <li><span class="field">access:</span> public</li>
 183              </ul>
 184      
 185      <div class="method-signature">
 186          <span class="method-result">integer</span>
 187          <span class="method-name">
 188              key
 189          </span>
 190                  ()
 191              </div>
 192      
 193          
 194          
 195      </div>
 196  <a name="methodnext" id="next"><!-- --></a>
 197  <div class="evenrow">
 198      
 199      <div class="method-header">
 200          <span class="method-title">next</span> (line <span class="line-number">341</span>)
 201      </div> 
 202      
 203      <!-- ========== Info from phpDoc block ========= -->
 204  <p class="short-description">Moves the internal pointer to the next array item.</p>
 205  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 206      <ul class="tags">
 207                  <li><span class="field">access:</span> public</li>
 208              </ul>
 209      
 210      <div class="method-signature">
 211          <span class="method-result">void</span>
 212          <span class="method-name">
 213              next
 214          </span>
 215                  ()
 216              </div>
 217      
 218          
 219          
 220      </div>
 221  <a name="methodrewind" id="rewind"><!-- --></a>
 222  <div class="oddrow">
 223      
 224      <div class="method-header">
 225          <span class="method-title">rewind</span> (line <span class="line-number">312</span>)
 226      </div> 
 227      
 228      <!-- ========== Info from phpDoc block ========= -->
 229  <p class="short-description">Rewinds internal array pointer.</p>
 230  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 231      <ul class="tags">
 232                  <li><span class="field">access:</span> public</li>
 233              </ul>
 234      
 235      <div class="method-signature">
 236          <span class="method-result">void</span>
 237          <span class="method-name">
 238              rewind
 239          </span>
 240                  ()
 241              </div>
 242      
 243          
 244          
 245      </div>
 246  <a name="methodvalid" id="valid"><!-- --></a>
 247  <div class="evenrow">
 248      
 249      <div class="method-header">
 250          <span class="method-title">valid</span> (line <span class="line-number">351</span>)
 251      </div> 
 252      
 253      <!-- ========== Info from phpDoc block ========= -->
 254  <p class="short-description">Returns whether there is an item at current position.</p>
 255  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 256      <ul class="tags">
 257                  <li><span class="field">access:</span> public</li>
 258              </ul>
 259      
 260      <div class="method-signature">
 261          <span class="method-result">boolean</span>
 262          <span class="method-name">
 263              valid
 264          </span>
 265                  ()
 266              </div>
 267      
 268          
 269          
 270      </div>
 271                          
 272          </div>
 273      </div>
 274  
 275  
 276      <p class="notes" id="credit">
 277          Documentation generated on Mon, 04 Dec 2006 11:27:14 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 278      </p>
 279      </div></body>
 280  </html>