interface/modules/zend_modules/library/Zend/View/Strategy/JsonStrategy.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\Http\Request as HttpRequest;
  15 use Zend\View\Model;
  16 use Zend\View\Renderer\JsonRenderer;
  17 use Zend\View\ViewEvent;
  18
  19 class JsonStrategy extends AbstractListenerAggregate
  20 {
  21     /**
  22      * Character set for associated content-type
  23      *
  24      * @var string
  25      */
  26     protected $charset = 'utf-8';
  27
  28     /**
  29      * Multibyte character sets that will trigger a binary content-transfer-encoding
  30      *
  31      * @var array
  32      */
  33     protected $multibyteCharsets = array(
  34         'UTF-16',
  35         'UTF-32',
  36     );
  37
  38     /**
  39      * @var JsonRenderer
  40      */
  41     protected $renderer;
  42
  43     /**
  44      * Constructor
  45      *
  46      * @param  JsonRenderer $renderer
  47      */
  48     public function __construct(JsonRenderer $renderer)
  49     {
  50         $this->renderer = $renderer;
  51     }
  52
  53     /**
  54      * {@inheritDoc}
  55      */
  56     public function attach(EventManagerInterface $events, $priority = 1)
  57     {
  58         $this->listeners[] = $events->attach(ViewEvent::EVENT_RENDERER, array($this, 'selectRenderer'), $priority);
  59         $this->listeners[] = $events->attach(ViewEvent::EVENT_RESPONSE, array($this, 'injectResponse'), $priority);
  60     }
  61
  62     /**
  63      * Set the content-type character set
  64      *
  65      * @param  string $charset
  66      * @return JsonStrategy
  67      */
  68     public function setCharset($charset)
  69     {
  70         $this->charset = (string) $charset;
  71         return $this;
  72     }
  73
  74     /**
  75      * Retrieve the current character set
  76      *
  77      * @return string
  78      */
  79     public function getCharset()
  80     {
  81         return $this->charset;
  82     }
  83
  84     /**
  85      * Detect if we should use the JsonRenderer based on model type and/or
  86      * Accept header
  87      *
  88      * @param  ViewEvent $e
  89      * @return null|JsonRenderer
  90      */
  91     public function selectRenderer(ViewEvent $e)
  92     {
  93         $model = $e->getModel();
  94
  95         if (!$model instanceof Model\JsonModel) {
  96             // no JsonModel; do nothing
  97             return;
  98         }
  99
 100         // JsonModel found
 101         return $this->renderer;
 102     }
 103
 104     /**
 105      * Inject the response with the JSON payload and appropriate Content-Type header
 106      *
 107      * @param  ViewEvent $e
 108      * @return void
 109      */
 110     public function injectResponse(ViewEvent $e)
 111     {
 112         $renderer = $e->getRenderer();
 113         if ($renderer !== $this->renderer) {
 114             // Discovered renderer is not ours; do nothing
 115             return;
 116         }
 117
 118         $result   = $e->getResult();
 119         if (!is_string($result)) {
 120             // We don't have a string, and thus, no JSON
 121             return;
 122         }
 123
 124         // Populate response
 125         $response = $e->getResponse();
 126         $response->setContent($result);
 127         $headers = $response->getHeaders();
 128
 129         if ($this->renderer->hasJsonpCallback()) {
 130             $contentType = 'application/javascript';
 131         } else {
 132             $contentType = 'application/json';
 133         }
 134
 135         $contentType .= '; charset=' . $this->charset;
 136         $headers->addHeaderLine('content-type', $contentType);
 137
 138         if (in_array(strtoupper($this->charset), $this->multibyteCharsets)) {
 139             $headers->addHeaderLine('content-transfer-encoding', 'BINARY');
 140         }
 141     }
 142 }