interface/modules/zend_modules/library/Zend/View/Renderer/ConsoleRenderer.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\Renderer;
  11
  12 use Zend\Filter\FilterChain;
  13 use Zend\View\Model\ModelInterface;
  14 use Zend\View\Resolver\ResolverInterface;
  15
  16 /**
  17  * Abstract class for Zend_View to help enforce private constructs.
  18  *
  19  * Note: all private variables in this class are prefixed with "__". This is to
  20  * mark them as part of the internal implementation, and thus prevent conflict
  21  * with variables injected into the renderer.
  22  */
  23 class ConsoleRenderer implements RendererInterface, TreeRendererInterface
  24 {
  25     /**
  26      * @var FilterChain
  27      */
  28     protected $__filterChain;
  29
  30     /**
  31      * Constructor.
  32      *
  33      *
  34      * @todo handle passing helper manager, options
  35      * @todo handle passing filter chain, options
  36      * @todo handle passing variables object, options
  37      * @todo handle passing resolver object, options
  38      * @param array $config Configuration key-value pairs.
  39      */
  40     public function __construct($config = array())
  41     {
  42         $this->init();
  43     }
  44
  45     public function setResolver(ResolverInterface $resolver)
  46     {
  47         return $this;
  48     }
  49
  50     /**
  51      * Return the template engine object
  52      *
  53      * Returns the object instance, as it is its own template engine
  54      *
  55      * @return PhpRenderer
  56      */
  57     public function getEngine()
  58     {
  59         return $this;
  60     }
  61
  62     /**
  63      * Allow custom object initialization when extending Zend_View_Abstract or
  64      * Zend_View
  65      *
  66      * Triggered by {@link __construct() the constructor} as its final action.
  67      *
  68      * @return void
  69      */
  70     public function init()
  71     {
  72     }
  73
  74     /**
  75      * Set filter chain
  76      *
  77      * @param  FilterChain $filters
  78      * @return ConsoleRenderer
  79      */
  80     public function setFilterChain(FilterChain $filters)
  81     {
  82         $this->__filterChain = $filters;
  83         return $this;
  84     }
  85
  86     /**
  87      * Retrieve filter chain for post-filtering script content
  88      *
  89      * @return FilterChain
  90      */
  91     public function getFilterChain()
  92     {
  93         if (null === $this->__filterChain) {
  94             $this->setFilterChain(new FilterChain());
  95         }
  96         return $this->__filterChain;
  97     }
  98
  99     /**
 100      * Recursively processes all ViewModels and returns output.
 101      *
 102      * @param  string|ModelInterface   $model        A ViewModel instance.
 103      * @param  null|array|\Traversable $values       Values to use when rendering. If none
 104      *                                               provided, uses those in the composed
 105      *                                               variables container.
 106      * @return string Console output.
 107      */
 108     public function render($model, $values = null)
 109     {
 110         if (!$model instanceof ModelInterface) {
 111             return '';
 112         }
 113
 114         $result = '';
 115         $options = $model->getOptions();
 116         foreach ($options as $setting => $value) {
 117             $method = 'set' . $setting;
 118             if (method_exists($this, $method)) {
 119                 $this->$method($value);
 120             }
 121             unset($method, $setting, $value);
 122         }
 123         unset($options);
 124
 125         $values = $model->getVariables();
 126
 127         if (isset($values['result'])) {
 128             // filter and append the result
 129             $result .= $this->getFilterChain()->filter($values['result']);
 130         }
 131
 132         if ($model->hasChildren()) {
 133             // recursively render all children
 134             foreach ($model->getChildren() as $child) {
 135                 $result .= $this->render($child, $values);
 136             }
 137         }
 138
 139         return $result;
 140     }
 141
 142     /**
 143      * @see Zend\View\Renderer\TreeRendererInterface
 144      * @return bool
 145      */
 146     public function canRenderTrees()
 147     {
 148         return true;
 149     }
 150 }