[Sommaire] [Imprimer]

   1  <?php
   2  
   3  /*
   4   * This file is part of the symfony package.
   5   * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
   6   * (c) 2004-2006 Sean Kerr.
   7   * 
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  /**
  13   * sfActionStackEntry represents information relating to a single sfAction request during a single HTTP request.
  14   *
  15   * @package    symfony
  16   * @subpackage action
  17   * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
  18   * @author     Sean Kerr <skerr@mojavi.org>
  19   * @version    SVN: $Id: sfActionStackEntry.class.php 3198 2007-01-08 20:36:20Z fabien $
  20   */
  21  class sfActionStackEntry
  22  {
  23    protected
  24      $actionInstance = null,
  25      $actionName     = null,
  26      $moduleName     = null,
  27      $presentation   = null,
  28      $viewInstance   = null;
  29  
  30    /**
  31     * Class constructor.
  32     *
  33     * @param string A module name
  34     * @param string An action name
  35     * @param sfAction An sfAction implementation instance
  36     */
  37    public function __construct($moduleName, $actionName, $actionInstance)
  38    {
  39      $this->actionName     = $actionName;
  40      $this->actionInstance = $actionInstance;
  41      $this->moduleName     = $moduleName;
  42    }
  43  
  44    /**
  45     * Retrieves this entry's action name.
  46     *
  47     * @return string An action name
  48     */
  49    public function getActionName()
  50    {
  51      return $this->actionName;
  52    }
  53  
  54    /**
  55     * Retrieves this entry's action instance.
  56     *
  57     * @return sfAction An sfAction implementation instance
  58     */
  59    public function getActionInstance()
  60    {
  61      return $this->actionInstance;
  62    }
  63  
  64    /**
  65     * Retrieves this entry's view instance.
  66     *
  67     * @return sfView A sfView implementation instance.
  68     */
  69    public function getViewInstance()
  70    {
  71      return $this->viewInstance;
  72    }
  73  
  74    /**
  75     * Sets this entry's view instance.
  76     *
  77     * @param sfView A sfView implementation instance.
  78     */
  79    public function setViewInstance($viewInstance)
  80    {
  81      $this->viewInstance = $viewInstance;
  82    }
  83  
  84    /**
  85     * Retrieves this entry's module name.
  86     *
  87     * @return string A module name
  88     */
  89    public function getModuleName()
  90    {
  91      return $this->moduleName;
  92    }
  93  
  94    /**
  95     * Retrieves this entry's rendered view presentation.
  96     *
  97     * This will only exist if the view has processed and the render mode is set to sfView::RENDER_VAR.
  98     *
  99     * @return string Rendered view presentation
 100     */
 101    public function & getPresentation()
 102    {
 103      return $this->presentation;
 104    }
 105  
 106    /**
 107     * Sets the rendered presentation for this action.
 108     *
 109     * @param string A rendered presentation.
 110     */
 111    public function setPresentation(&$presentation)
 112    {
 113      $this->presentation =& $presentation;
 114    }
 115  }