interface/modules/zend_modules/library/Zend/View/Strategy/PhpRendererStrategy.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\View\Strategy;
  11
  12 use Zend\EventManager\AbstractListenerAggregate;
  13 use Zend\EventManager\EventManagerInterface;
  14 use Zend\View\Renderer\PhpRenderer;
  15 use Zend\View\ViewEvent;
  16
  17 class PhpRendererStrategy extends AbstractListenerAggregate
  18 {
  19     /**
  20      * Placeholders that may hold content
  21      *
  22      * @var array
  23      */
  24     protected $contentPlaceholders = array('article', 'content');
  25
  26     /**
  27      * @var PhpRenderer
  28      */
  29     protected $renderer;
  30
  31     /**
  32      * Constructor
  33      *
  34      * @param  PhpRenderer $renderer
  35      */
  36     public function __construct(PhpRenderer $renderer)
  37     {
  38         $this->renderer = $renderer;
  39     }
  40
  41     /**
  42      * Retrieve the composed renderer
  43      *
  44      * @return PhpRenderer
  45      */
  46     public function getRenderer()
  47     {
  48         return $this->renderer;
  49     }
  50
  51     /**
  52      * Set list of possible content placeholders
  53      *
  54      * @param  array $contentPlaceholders
  55      * @return PhpRendererStrategy
  56      */
  57     public function setContentPlaceholders(array $contentPlaceholders)
  58     {
  59         $this->contentPlaceholders = $contentPlaceholders;
  60         return $this;
  61     }
  62
  63     /**
  64      * Get list of possible content placeholders
  65      *
  66      * @return array
  67      */
  68     public function getContentPlaceholders()
  69     {
  70         return $this->contentPlaceholders;
  71     }
  72
  73     /**
  74      * {@inheritDoc}
  75      */
  76     public function attach(EventManagerInterface $events, $priority = 1)
  77     {
  78         $this->listeners[] = $events->attach(ViewEvent::EVENT_RENDERER, array($this, 'selectRenderer'), $priority);
  79         $this->listeners[] = $events->attach(ViewEvent::EVENT_RESPONSE, array($this, 'injectResponse'), $priority);
  80     }
  81
  82     /**
  83      * Select the PhpRenderer; typically, this will be registered last or at
  84      * low priority.
  85      *
  86      * @param  ViewEvent $e
  87      * @return PhpRenderer
  88      */
  89     public function selectRenderer(ViewEvent $e)
  90     {
  91         return $this->renderer;
  92     }
  93
  94     /**
  95      * Populate the response object from the View
  96      *
  97      * Populates the content of the response object from the view rendering
  98      * results.
  99      *
 100      * @param ViewEvent $e
 101      * @return void
 102      */
 103     public function injectResponse(ViewEvent $e)
 104     {
 105         $renderer = $e->getRenderer();
 106         if ($renderer !== $this->renderer) {
 107             return;
 108         }
 109
 110         $result   = $e->getResult();
 111         $response = $e->getResponse();
 112
 113         // Set content
 114         // If content is empty, check common placeholders to determine if they are
 115         // populated, and set the content from them.
 116         if (empty($result)) {
 117             $placeholders = $renderer->plugin('placeholder');
 118             foreach ($this->contentPlaceholders as $placeholder) {
 119                 if ($placeholders->containerExists($placeholder)) {
 120                     $result = (string) $placeholders->getContainer($placeholder);
 121                     break;
 122                 }
 123             }
 124         }
 125         $response->setContent($result);
 126     }
 127 }