1. sfActionStack.class.php
  2. /**
 * sfActionStack keeps a list of all requested actions and provides accessor
 * methods for retrieving individual entries.
 *
 * @package    symfony
 * @subpackage action
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfActionStack.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfActionStack
  4. {
  5.   protected
  6.     $stack = array();
  8.   /**
  9.    * Adds an entry to the action stack.
  10.    *
  11.    * @param string   $moduleName     A module name
  12.    * @param string   $actionName     An action name
  13.    * @param sfAction $actionInstance An sfAction implementation instance
  14.    *
  15.    * @return sfActionStackEntry sfActionStackEntry instance
  16.    */
  17.   public function addEntry($moduleName, $actionName, $actionInstance)
  18.   {
  19.     // create our action stack entry and add it to our stack
  20.     $actionEntry = new sfActionStackEntry($moduleName, $actionName, $actionInstance);
  22.     $this->stack[] = $actionEntry;
  24.     return $actionEntry;
  25.   }
  27.   /**
  28.    * Retrieves the entry at a specific index.
  29.    *
  30.    * @param int $index An entry index
  31.    *
  32.    * @return sfActionStackEntry An action stack entry implementation.
  33.    */
  34.   public function getEntry($index)
  35.   {
  36.     $retval = null;
  38.     if ($index > -1 && $index < count($this->stack))
  39.     {
  40.       $retval = $this->stack[$index];
  41.     }
  43.     return $retval;
  44.   }
  46.   /**
  47.    * Removes the entry at a specific index.
  48.    *
  49.    * @return sfActionStackEntry An action stack entry implementation.
  50.    */
  51.   public function popEntry()
  52.   {
  53.     return array_pop($this->stack);
  54.   }
  56.   /**
  57.    * Retrieves the first entry.
  58.    *
  59.    * @return mixed An action stack entry implementation or null if there is no sfAction instance in the stack
  60.    */
  61.   public function getFirstEntry()
  62.   {
  63.     $retval = null;
  65.     if (isset($this->stack[0]))
  66.     {
  67.       $retval = $this->stack[0];
  68.     }
  70.     return $retval;
  71.   }
  73.   /**
  74.    * Retrieves the last entry.
  75.    *
  76.    * @return mixed An action stack entry implementation or null if there is no sfAction instance in the stack
  77.    */
  78.   public function getLastEntry()
  79.   {
  80.     $count  = count($this->stack);
  81.     $retval = null;
  83.     if (isset($this->stack[0]))
  84.     {
  85.       $retval = $this->stack[$count - 1];
  86.     }
  88.     return $retval;
  89.   }
  91.   /**
  92.    * Retrieves the size of this stack.
  93.    *
  94.    * @return int The size of this stack.
  95.    */
  96.   public function getSize()
  97.   {
  98.     return count($this->stack);
  99.   }
  100. }
Debug toolbar