[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 TStack</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 TStack</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><li></li>            </ul>
  27          </p>
  28                  <!-- ========== Info from phpDoc block ========= -->
  29  <p class="short-description">TStack class</p>
  30  <p class="description"><p>TStack implements a stack.</p><p>The typical stack operations are implemented, which include  <a href="../System.Collections/TStack.html#methodpush">push()</a>, <a href="../System.Collections/TStack.html#methodpop">pop()</a> and <a href="../System.Collections/TStack.html#methodpeek">peek()</a>. In addition,  <a href="../System.Collections/TStack.html#methodcontains">contains()</a> can be used to check if an item is contained  in the stack. To obtain the number of the items in the stack,  check the <a href="../System.Collections/TStack.html#methodgetCount">Count</a> property.</p><p>Items in the stack may be traversed using foreach as follows,  <pre><ol><code><pre><li> <span class="src-key">foreach</span><span class="src-sym">(</span><span class="src-var">$stack </span><span class="src-key">as </span><span class="src-var">$item</span><span class="src-sym">) </span>...</li>
  31  </pre></code></ol></pre></p></p>
  32      <ul class="tags">
  33                  <li><span class="field">since:</span> 3.0</li>
  34                  <li><span class="field">version:</span> $Id: TStack.php 1397 2006-09-07 07:55:53Z wei $</li>
  35                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  36              </ul>
  37          <p class="notes">
  38              Located in <a class="field" href="_Collections_TStack_php.html">/Collections/TStack.php</a> (line <span class="field">34</span>)
  39          </p>
  40          
  41                  
  42          <pre><a href="../System/TComponent.html">TComponent</a>
  43     |
  44     --TStack</pre>
  45      
  46              </div>
  47  </div>
  48  
  49  
  50  
  51  
  52      <a name="sec-method-summary"></a>
  53      <div class="info-box">
  54          <div class="info-box-title">Method Summary</span></div>
  55          <div class="nav-bar">
  56              <a href="#sec-description">Description</a> |
  57                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  58          </div>
  59          <div class="info-box-body">            
  60              <div class="method-summary">
  61                                  
  62                  <div class="method-definition">
  63                                              <span class="method-result">TStack</span>
  64                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  65                                              ([<span class="var-type">array|Iterator</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>])
  66                                      </div>
  67                                  
  68                  <div class="method-definition">
  69                                              <span class="method-result">void</span>
  70                                          <a href="#clear" title="details" class="method-name">clear</a>
  71                                          ()
  72                                      </div>
  73                                  
  74                  <div class="method-definition">
  75                                              <span class="method-result">boolean</span>
  76                                          <a href="#contains" title="details" class="method-name">contains</a>
  77                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
  78                                      </div>
  79                                  
  80                  <div class="method-definition">
  81                                              <span class="method-result">void</span>
  82                                          <a href="#copyFrom" title="details" class="method-name">copyFrom</a>
  83                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>)
  84                                      </div>
  85                                  
  86                  <div class="method-definition">
  87                                              <span class="method-result">integer</span>
  88                                          <a href="#count" title="details" class="method-name">count</a>
  89                                          ()
  90                                      </div>
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">integer</span>
  94                                          <a href="#getCount" title="details" class="method-name">getCount</a>
  95                                          ()
  96                                      </div>
  97                                  
  98                  <div class="method-definition">
  99                                              <span class="method-result">Iterator</span>
 100                                          <a href="#getIterator" title="details" class="method-name">getIterator</a>
 101                                          ()
 102                                      </div>
 103                                  
 104                  <div class="method-definition">
 105                                              <span class="method-result">mixed</span>
 106                                          <a href="#peek" title="details" class="method-name">peek</a>
 107                                          ()
 108                                      </div>
 109                                  
 110                  <div class="method-definition">
 111                                              <span class="method-result">mixed</span>
 112                                          <a href="#pop" title="details" class="method-name">pop</a>
 113                                          ()
 114                                      </div>
 115                                  
 116                  <div class="method-definition">
 117                                              <span class="method-result">void</span>
 118                                          <a href="#push" title="details" class="method-name">push</a>
 119                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
 120                                      </div>
 121                                  
 122                  <div class="method-definition">
 123                                              <span class="method-result">array</span>
 124                                          <a href="#toArray" title="details" class="method-name">toArray</a>
 125                                          ()
 126                                      </div>
 127                              </div>
 128          </div>
 129      </div>        
 130  
 131      
 132      <a name="sec-methods"></a>
 133      <div class="info-box">
 134          <div class="info-box-title">Methods</div>
 135          <div class="nav-bar">
 136              <a href="#sec-description">Description</a> |
 137                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 138                          
 139          </div>
 140          <div class="info-box-body">
 141              <A NAME='method_detail'></A>
 142  <a name="method__construct" id="__construct"><!-- --></a>
 143  <div class="oddrow">
 144      
 145      <div class="method-header">
 146          <span class="method-title">Constructor __construct</span> (line <span class="line-number">53</span>)
 147      </div> 
 148      
 149      <!-- ========== Info from phpDoc block ========= -->
 150  <p class="short-description">Constructor.</p>
 151  <p class="description"><p>Initializes the stack with an array or an iterable object.</p></p>
 152      <ul class="tags">
 153                  <li><span class="field">access:</span> public</li>
 154                  <li><span class="field">throws:</span> TInvalidDataTypeException If data is not null and neither an array nor an iterator.</li>
 155              </ul>
 156      
 157      <div class="method-signature">
 158          <span class="method-result">TStack</span>
 159          <span class="method-name">
 160              __construct
 161          </span>
 162                      ([<span class="var-type">array|Iterator</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>])
 163              </div>
 164      
 165              <ul class="parameters">
 166                      <li>
 167                  <span class="var-type">array|Iterator</span>
 168                  <span class="var-name">$data</span><span class="var-description">: the intial data. Default is null, meaning no initialization.</span>            </li>
 169                  </ul>
 170          
 171          
 172      </div>
 173  <a name="methodclear" id="clear"><!-- --></a>
 174  <div class="evenrow">
 175      
 176      <div class="method-header">
 177          <span class="method-title">clear</span> (line <span class="line-number">91</span>)
 178      </div> 
 179      
 180      <!-- ========== Info from phpDoc block ========= -->
 181  <p class="short-description">Removes all items in the stack.</p>
 182      <ul class="tags">
 183                  <li><span class="field">access:</span> public</li>
 184              </ul>
 185      
 186      <div class="method-signature">
 187          <span class="method-result">void</span>
 188          <span class="method-name">
 189              clear
 190          </span>
 191                  ()
 192              </div>
 193      
 194          
 195          
 196      </div>
 197  <a name="methodcontains" id="contains"><!-- --></a>
 198  <div class="oddrow">
 199      
 200      <div class="method-header">
 201          <span class="method-title">contains</span> (line <span class="line-number">101</span>)
 202      </div> 
 203      
 204      <!-- ========== Info from phpDoc block ========= -->
 205      <ul class="tags">
 206                  <li><span class="field">return:</span> whether the stack contains the item</li>
 207                  <li><span class="field">access:</span> public</li>
 208              </ul>
 209      
 210      <div class="method-signature">
 211          <span class="method-result">boolean</span>
 212          <span class="method-name">
 213              contains
 214          </span>
 215                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
 216              </div>
 217      
 218              <ul class="parameters">
 219                      <li>
 220                  <span class="var-type">mixed</span>
 221                  <span class="var-name">$item</span><span class="var-description">: the item</span>            </li>
 222                  </ul>
 223          
 224          
 225      </div>
 226  <a name="methodcopyFrom" id="copyFrom"><!-- --></a>
 227  <div class="evenrow">
 228      
 229      <div class="method-header">
 230          <span class="method-title">copyFrom</span> (line <span class="line-number">73</span>)
 231      </div> 
 232      
 233      <!-- ========== Info from phpDoc block ========= -->
 234  <p class="short-description">Copies iterable data into the stack.</p>
 235  <p class="description"><p>Note, existing data in the list will be cleared first.</p></p>
 236      <ul class="tags">
 237                  <li><span class="field">access:</span> public</li>
 238                  <li><span class="field">throws:</span> TInvalidDataTypeException If data is neither an array nor a Traversable.</li>
 239              </ul>
 240      
 241      <div class="method-signature">
 242          <span class="method-result">void</span>
 243          <span class="method-name">
 244              copyFrom
 245          </span>
 246                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>)
 247              </div>
 248      
 249              <ul class="parameters">
 250                      <li>
 251                  <span class="var-type">mixed</span>
 252                  <span class="var-name">$data</span><span class="var-description">: the data to be copied from, must be an array or object implementing Traversable</span>            </li>
 253                  </ul>
 254          
 255          
 256      </div>
 257  <a name="methodcount" id="count"><!-- --></a>
 258  <div class="oddrow">
 259      
 260      <div class="method-header">
 261          <span class="method-title">count</span> (line <span class="line-number">169</span>)
 262      </div> 
 263      
 264      <!-- ========== Info from phpDoc block ========= -->
 265  <p class="short-description">Returns the number of items in the stack.</p>
 266  <p class="description"><p>This method is required by Countable interface.</p></p>
 267      <ul class="tags">
 268                  <li><span class="field">return:</span> number of items in the stack.</li>
 269                  <li><span class="field">access:</span> public</li>
 270              </ul>
 271      
 272      <div class="method-signature">
 273          <span class="method-result">integer</span>
 274          <span class="method-name">
 275              count
 276          </span>
 277                  ()
 278              </div>
 279      
 280          
 281          
 282      </div>
 283  <a name="methodgetCount" id="getCount"><!-- --></a>
 284  <div class="evenrow">
 285      
 286      <div class="method-header">
 287          <span class="method-title">getCount</span> (line <span class="line-number">159</span>)
 288      </div> 
 289      
 290      <!-- ========== Info from phpDoc block ========= -->
 291      <ul class="tags">
 292                  <li><span class="field">return:</span> the number of items in the stack</li>
 293                  <li><span class="field">access:</span> public</li>
 294              </ul>
 295      
 296      <div class="method-signature">
 297          <span class="method-result">integer</span>
 298          <span class="method-name">
 299              getCount
 300          </span>
 301                  ()
 302              </div>
 303      
 304          
 305          
 306      </div>
 307  <a name="methodgetIterator" id="getIterator"><!-- --></a>
 308  <div class="oddrow">
 309      
 310      <div class="method-header">
 311          <span class="method-title">getIterator</span> (line <span class="line-number">151</span>)
 312      </div> 
 313      
 314      <!-- ========== Info from phpDoc block ========= -->
 315  <p class="short-description">Returns an iterator for traversing the items in the stack.</p>
 316  <p class="description"><p>This method is required by the interface IteratorAggregate.</p></p>
 317      <ul class="tags">
 318                  <li><span class="field">return:</span> an iterator for traversing the items in the stack.</li>
 319                  <li><span class="field">access:</span> public</li>
 320              </ul>
 321      
 322      <div class="method-signature">
 323          <span class="method-result">Iterator</span>
 324          <span class="method-name">
 325              getIterator
 326          </span>
 327                  ()
 328              </div>
 329      
 330          
 331          
 332      </div>
 333  <a name="methodpeek" id="peek"><!-- --></a>
 334  <div class="evenrow">
 335      
 336      <div class="method-header">
 337          <span class="method-title">peek</span> (line <span class="line-number">112</span>)
 338      </div> 
 339      
 340      <!-- ========== Info from phpDoc block ========= -->
 341  <p class="short-description">Returns the item at the top of the stack.</p>
 342  <p class="description"><p>Unlike <a href="../System.Collections/TStack.html#methodpop">pop()</a>, this method does not remove the item from the stack.</p></p>
 343      <ul class="tags">
 344                  <li><span class="field">return:</span> item at the top of the stack</li>
 345                  <li><span class="field">access:</span> public</li>
 346                  <li><span class="field">throws:</span> TInvalidOperationException if the stack is empty</li>
 347              </ul>
 348      
 349      <div class="method-signature">
 350          <span class="method-result">mixed</span>
 351          <span class="method-name">
 352              peek
 353          </span>
 354                  ()
 355              </div>
 356      
 357          
 358          
 359      </div>
 360  <a name="methodpop" id="pop"><!-- --></a>
 361  <div class="oddrow">
 362      
 363      <div class="method-header">
 364          <span class="method-title">pop</span> (line <span class="line-number">125</span>)
 365      </div> 
 366      
 367      <!-- ========== Info from phpDoc block ========= -->
 368  <p class="short-description">Pops up the item at the top of the stack.</p>
 369      <ul class="tags">
 370                  <li><span class="field">return:</span> the item at the top of the stack</li>
 371                  <li><span class="field">access:</span> public</li>
 372                  <li><span class="field">throws:</span> TInvalidOperationException if the stack is empty</li>
 373              </ul>
 374      
 375      <div class="method-signature">
 376          <span class="method-result">mixed</span>
 377          <span class="method-name">
 378              pop
 379          </span>
 380                  ()
 381              </div>
 382      
 383          
 384          
 385      </div>
 386  <a name="methodpush" id="push"><!-- --></a>
 387  <div class="evenrow">
 388      
 389      <div class="method-header">
 390          <span class="method-title">push</span> (line <span class="line-number">140</span>)
 391      </div> 
 392      
 393      <!-- ========== Info from phpDoc block ========= -->
 394  <p class="short-description">Pushes an item into the stack.</p>
 395      <ul class="tags">
 396                  <li><span class="field">access:</span> public</li>
 397              </ul>
 398      
 399      <div class="method-signature">
 400          <span class="method-result">void</span>
 401          <span class="method-name">
 402              push
 403          </span>
 404                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
 405              </div>
 406      
 407              <ul class="parameters">
 408                      <li>
 409                  <span class="var-type">mixed</span>
 410                  <span class="var-name">$item</span><span class="var-description">: the item to be pushed into the stack</span>            </li>
 411                  </ul>
 412          
 413          
 414      </div>
 415  <a name="methodtoArray" id="toArray"><!-- --></a>
 416  <div class="oddrow">
 417      
 418      <div class="method-header">
 419          <span class="method-title">toArray</span> (line <span class="line-number">62</span>)
 420      </div> 
 421      
 422      <!-- ========== Info from phpDoc block ========= -->
 423      <ul class="tags">
 424                  <li><span class="field">return:</span> the list of items in stack</li>
 425                  <li><span class="field">access:</span> public</li>
 426              </ul>
 427      
 428      <div class="method-signature">
 429          <span class="method-result">array</span>
 430          <span class="method-name">
 431              toArray
 432          </span>
 433                  ()
 434              </div>
 435      
 436          
 437          
 438      </div>
 439                              <h4>Inherited Methods</h4>
 440                  <a name='inherited_methods'><!-- --></a>    
 441                                      <!-- =========== Summary =========== -->
 442                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 443                      <blockquote>
 444                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 445                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 446                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 447                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 448                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 449                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 450                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 451                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 452                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 453                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 454                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 455                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 456                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 457                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 458                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 459                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 460                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 461                                              </blockquote>
 462                                          
 463          </div>
 464      </div>
 465  
 466  
 467      <p class="notes" id="credit">
 468          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>
 469      </p>
 470      </div></body>
 471  </html>