[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 TStackIterator</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 TStackIterator</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">TStackIterator class</p>
  30  <p class="description"><p>TStackIterator implements Iterator interface.</p><p>TStackIterator is used by TStack. It allows TStack to return a new iterator  for traversing the items in the list.</p></p>
  31      <ul class="tags">
  32                  <li><span class="field">since:</span> 3.0</li>
  33                  <li><span class="field">version:</span> $Id: TStack.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_TStack_php.html">/Collections/TStack.php</a> (line <span class="field">188</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">TStackIterator</span>
  61                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  62                                              (<span class="var-type">array</span>&nbsp;<span class="var-name">&$data</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="evenrow">
 111      
 112      <div class="method-header">
 113          <span class="method-title">Constructor __construct</span> (line <span class="line-number">207</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">TStackIterator</span>
 124          <span class="method-name">
 125              __construct
 126          </span>
 127                      (<span class="var-type">array</span>&nbsp;<span class="var-name">&$data</span>)
 128              </div>
 129      
 130              <ul class="parameters">
 131                      <li>
 132                  <span class="var-type">array</span>
 133                  <span class="var-name">&$data</span><span class="var-description">: the data to be iterated through</span>            </li>
 134                  </ul>
 135          
 136          
 137      </div>
 138  <a name="methodcurrent" id="current"><!-- --></a>
 139  <div class="oddrow">
 140      
 141      <div class="method-header">
 142          <span class="method-title">current</span> (line <span class="line-number">238</span>)
 143      </div> 
 144      
 145      <!-- ========== Info from phpDoc block ========= -->
 146  <p class="short-description">Returns the current array item.</p>
 147  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 148      <ul class="tags">
 149                  <li><span class="field">return:</span> the current array item</li>
 150                  <li><span class="field">access:</span> public</li>
 151              </ul>
 152      
 153      <div class="method-signature">
 154          <span class="method-result">mixed</span>
 155          <span class="method-name">
 156              current
 157          </span>
 158                  ()
 159              </div>
 160      
 161          
 162          
 163      </div>
 164  <a name="methodkey" id="key"><!-- --></a>
 165  <div class="evenrow">
 166      
 167      <div class="method-header">
 168          <span class="method-title">key</span> (line <span class="line-number">228</span>)
 169      </div> 
 170      
 171      <!-- ========== Info from phpDoc block ========= -->
 172  <p class="short-description">Returns the key of the current array item.</p>
 173  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 174      <ul class="tags">
 175                  <li><span class="field">return:</span> the key of the current array item</li>
 176                  <li><span class="field">access:</span> public</li>
 177              </ul>
 178      
 179      <div class="method-signature">
 180          <span class="method-result">integer</span>
 181          <span class="method-name">
 182              key
 183          </span>
 184                  ()
 185              </div>
 186      
 187          
 188          
 189      </div>
 190  <a name="methodnext" id="next"><!-- --></a>
 191  <div class="oddrow">
 192      
 193      <div class="method-header">
 194          <span class="method-title">next</span> (line <span class="line-number">247</span>)
 195      </div> 
 196      
 197      <!-- ========== Info from phpDoc block ========= -->
 198  <p class="short-description">Moves the internal pointer to the next array item.</p>
 199  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 200      <ul class="tags">
 201                  <li><span class="field">access:</span> public</li>
 202              </ul>
 203      
 204      <div class="method-signature">
 205          <span class="method-result">void</span>
 206          <span class="method-name">
 207              next
 208          </span>
 209                  ()
 210              </div>
 211      
 212          
 213          
 214      </div>
 215  <a name="methodrewind" id="rewind"><!-- --></a>
 216  <div class="evenrow">
 217      
 218      <div class="method-header">
 219          <span class="method-title">rewind</span> (line <span class="line-number">218</span>)
 220      </div> 
 221      
 222      <!-- ========== Info from phpDoc block ========= -->
 223  <p class="short-description">Rewinds internal array pointer.</p>
 224  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 225      <ul class="tags">
 226                  <li><span class="field">access:</span> public</li>
 227              </ul>
 228      
 229      <div class="method-signature">
 230          <span class="method-result">void</span>
 231          <span class="method-name">
 232              rewind
 233          </span>
 234                  ()
 235              </div>
 236      
 237          
 238          
 239      </div>
 240  <a name="methodvalid" id="valid"><!-- --></a>
 241  <div class="oddrow">
 242      
 243      <div class="method-header">
 244          <span class="method-title">valid</span> (line <span class="line-number">257</span>)
 245      </div> 
 246      
 247      <!-- ========== Info from phpDoc block ========= -->
 248  <p class="short-description">Returns whether there is an item at current position.</p>
 249  <p class="description"><p>This method is required by the interface Iterator.</p></p>
 250      <ul class="tags">
 251                  <li><span class="field">access:</span> public</li>
 252              </ul>
 253      
 254      <div class="method-signature">
 255          <span class="method-result">boolean</span>
 256          <span class="method-name">
 257              valid
 258          </span>
 259                  ()
 260              </div>
 261      
 262          
 263          
 264      </div>
 265                          
 266          </div>
 267      </div>
 268  
 269  
 270      <p class="notes" id="credit">
 271          Documentation generated on Mon, 04 Dec 2006 11:27:32 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 272      </p>
 273      </div></body>
 274  </html>