phpDocumentor phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
phpDocumentor
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Source for file EventStack.inc

Documentation is available at EventStack.inc

  1. <?php
  2. /**
  3.  * An Event Stack for inter-program communication, particularly for parsing
  4.  *
  5.  * phpDocumentor :: automatic documentation generator
  6.  * 
  7.  * PHP versions 4 and 5
  8.  *
  9.  * Copyright (c) 2000-2006 Joshua Eichorn
  10.  * 
  11.  * LICENSE:
  12.  * 
  13.  * This library is free software; you can redistribute it
  14.  * and/or modify it under the terms of the GNU Lesser General
  15.  * Public License as published by the Free Software Foundation;
  16.  * either version 2.1 of the License, or (at your option) any
  17.  * later version.
  18.  * 
  19.  * This library is distributed in the hope that it will be useful,
  20.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22.  * Lesser General Public License for more details.
  23.  * 
  24.  * You should have received a copy of the GNU Lesser General Public
  25.  * License along with this library; if not, write to the Free Software
  26.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27.  *
  28.  * @package    phpDocumentor
  29.  * @author     Joshua Eichorn <[email protected]>
  30.  * @copyright  2000-2006 Joshua Eichorn
  31.  * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL
  32.  * @version    CVS: $Id: EventStack.inc,v 1.3 2006/04/30 22:18:13 cellog Exp $
  33.  * @filesource
  34.  * @link       http://www.phpdoc.org
  35.  * @link       http://pear.php.net/PhpDocumentor
  36.  * @since      0.1
  37.  */
  38. /**
  39.  * An event Stack
  40.  * 
  41.  * @author    Joshua Eichorn <[email protected]>
  42.  * @version    $Id: EventStack.inc,v 1.3 2006/04/30 22:18:13 cellog Exp $
  43.  * @package     phpDocumentor
  44.  */
  45. class EventStack
  46. {
  47.     /**
  48.      * The stack
  49.      * @var array 
  50.      */
  51.     var $stack = array(PARSER_EVENT_NOEVENTS);
  52.  
  53.     /**
  54.      * The number of events in the stack
  55.      * @var integer 
  56.      */
  57.     var $num = 0;
  58.  
  59.     /**
  60.      * Push an event onto the stack
  61.      *
  62.      * @param    int    $event    All events must be constants
  63.      */
  64.     function pushEvent($event)
  65.     {
  66.         $this->num = array_push($this->stack,$event) - 1;
  67.     }
  68.  
  69.     /**
  70.      * Pop an event from the stack
  71.      *
  72.      * @return    int    An event
  73.      */
  74.     function popEvent()
  75.     {
  76.         $this->num--;
  77.         return array_pop($this->stack);
  78.     }
  79.  
  80.     /**
  81.      * Get the current event
  82.      *
  83.      * @return    int    An event
  84.      */
  85.     function getEvent()
  86.     {
  87.         return $this->stack[$this->num];
  88.     }
  89. }
Documentation generated on Tue, 24 Oct 2006 09:22:29 -0500 by phpDocumentor 1.3.1