1. sfPHPView.class.php
  2. /**
 * A view that uses PHP as the templating engine.
 *
 * @package    symfony
 * @subpackage view
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfPHPView.class.php 24615 2009-11-30 22:30:46Z Kris.Wallsmith $
 */
  3. class sfPHPView extends sfView
  4. {
  5.   /**
  6.    * Executes any presentation logic for this view.
  7.    */
  8.   public function execute()
  9.   {
  10.   }
  12.   /**
  13.    * Loads core and standard helpers to be use in the template.
  14.    */
  15.   protected function loadCoreAndStandardHelpers()
  16.   {
  17.     static $coreHelpersLoaded = 0;
  19.     if ($coreHelpersLoaded)
  20.     {
  21.       return;
  22.     }
  24.     $coreHelpersLoaded = 1;
  26.     $helpers = array_unique(array_merge(array('Helper', 'Url', 'Asset', 'Tag', 'Escaping'), sfConfig::get('sf_standard_helpers')));
  28.     $this->context->getConfiguration()->loadHelpers($helpers);
  29.   }
  31.   /**
  32.    * Renders the presentation.
  33.    *
  34.    * @param  string $_sfFile  Filename
  35.    *
  36.    * @return string File content
  37.    */
  38.   protected function renderFile($_sfFile)
  39.   {
  40.     if (sfConfig::get('sf_logging_enabled'))
  41.     {
  42.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Render "%s"', $_sfFile))));
  43.     }
  45.     $this->loadCoreAndStandardHelpers();
  47.     // EXTR_REFS can't be used (see #3595 and #3151)
  48.     $vars = $this->attributeHolder->toArray();
  49.     extract($vars);
  51.     // render
  52.     ob_start();
  53.     ob_implicit_flush(0);
  55.     try
  56.     {
  57.       require($_sfFile);
  58.     }
  59.     catch (Exception $e)
  60.     {
  61.       // need to end output buffering before throwing the exception #7596
  62.       ob_end_clean();
  63.       throw $e;
  64.     }
  66.     return ob_get_clean();
  67.   }
  69.   /**
  70.    * Retrieves the template engine associated with this view.
  71.    *
  72.    * Note: This will return null because PHP itself has no engine reference.
  73.    *
  74.    * @return null
  75.    */
  76.   public function getEngine()
  77.   {
  78.     return null;
  79.   }
  81.   /**
  82.    * Configures template.
  83.    *
  84.    * @return void
  85.    */
  86.   public function configure()
  87.   {
  88.     // store our current view
  89.     $this->context->set('view_instance', $this);
  91.     // require our configuration
  92.     require($this->context->getConfigCache()->checkConfig('modules/'.$this->moduleName.'/config/view.yml'));
  94.     // set template directory
  95.     if (!$this->directory)
  96.     {
  97.       $this->setDirectory($this->context->getConfiguration()->getTemplateDir($this->moduleName, $this->getTemplate()));
  98.     }
  99.   }
  101.   /**
  102.    * Loop through all template slots and fill them in with the results of presentation data.
  103.    *
  104.    * @param  string $content  A chunk of decorator content
  105.    *
  106.    * @return string A decorated template
  107.    */
  108.   protected function decorate($content)
  109.   {
  110.     if (sfConfig::get('sf_logging_enabled'))
  111.     {
  112.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Decorate content with "%s/%s"', $this->getDecoratorDirectory(), $this->getDecoratorTemplate()))));
  113.     }
  115.     // set the decorator content as an attribute
  116.     $attributeHolder = $this->attributeHolder;
  118.     $this->attributeHolder = $this->initializeAttributeHolder(array('sf_content' => new sfOutputEscaperSafe($content)));
  119.     $this->attributeHolder->set('sf_type', 'layout');
  121.     // render the decorator template and return the result
  122.     $ret = $this->renderFile($this->getDecoratorDirectory().'/'.$this->getDecoratorTemplate());
  124.     $this->attributeHolder = $attributeHolder;
  126.     return $ret;
  127.   }
  129.   /**
  130.    * Renders the presentation.
  131.    *
  132.    * @return string A string representing the rendered presentation
  133.    */
  134.   public function render()
  135.   {
  136.     $content = null;
  137.     if (sfConfig::get('sf_cache'))
  138.     {
  139.       $viewCache = $this->context->getViewCacheManager();
  140.       $uri = $viewCache->getCurrentCacheKey();
  142.       if (null !== $uri)
  143.       {
  144.         list($content, $decoratorTemplate) = $viewCache->getActionCache($uri);
  145.         if (null !== $content)
  146.         {
  147.           $this->setDecoratorTemplate($decoratorTemplate);
  148.         }
  149.       }
  150.     }
  152.     // render template if no cache
  153.     if (null === $content)
  154.     {
  155.       // execute pre-render check
  156.       $this->preRenderCheck();
  158.       $this->attributeHolder->set('sf_type', 'action');
  160.       // render template file
  161.       $content = $this->renderFile($this->getDirectory().'/'.$this->getTemplate());
  163.       if (sfConfig::get('sf_cache') && null !== $uri)
  164.       {
  165.         $content = $viewCache->setActionCache($uri, $content, $this->isDecorator() ? $this->getDecoratorDirectory().'/'.$this->getDecoratorTemplate() : false);
  166.       }
  167.     }
  169.     // now render decorator template, if one exists
  170.     if ($this->isDecorator())
  171.     {
  172.       $content = $this->decorate($content);
  173.     }
  175.     return $content;
  176.   }
  177. }
Debug toolbar