interface/modules/zend_modules/library/Zend/View/Helper/Escaper/AbstractHelper.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-2015 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\Helper\Escaper;
  11
  12 use Zend\Escaper;
  13 use Zend\View\Exception;
  14 use Zend\View\Helper;
  15
  16 /**
  17  * Helper for escaping values
  18  */
  19 abstract class AbstractHelper extends Helper\AbstractHelper
  20 {
  21     /**
  22      * @const Recursion constants
  23      */
  24     const RECURSE_NONE   = 0x00;
  25     const RECURSE_ARRAY  = 0x01;
  26     const RECURSE_OBJECT = 0x02;
  27
  28     /**
  29      * @var string Encoding
  30      */
  31     protected $encoding = 'UTF-8';
  32
  33     /**
  34      * @var Escaper\Escaper
  35      */
  36     protected $escaper = null;
  37
  38     /**
  39      * Invoke this helper: escape a value
  40      *
  41      * @param  mixed $value
  42      * @param  int   $recurse Expects one of the recursion constants;
  43      *                        used to decide whether or not to recurse the given value when escaping
  44      * @throws Exception\InvalidArgumentException
  45      * @return mixed Given a scalar, a scalar value is returned. Given an object, with the $recurse flag not
  46      *               allowing object recursion, returns a string. Otherwise, returns an array.
  47      */
  48     public function __invoke($value, $recurse = self::RECURSE_NONE)
  49     {
  50         if (is_string($value)) {
  51             return $this->escape($value);
  52         }
  53
  54         if (is_array($value)) {
  55             if (!(self::RECURSE_ARRAY & $recurse)) {
  56                 throw new Exception\InvalidArgumentException(
  57                     'Array provided to Escape helper, but flags do not allow recursion'
  58                 );
  59             }
  60             foreach ($value as $k => $v) {
  61                 $value[$k] = $this->__invoke($v, $recurse);
  62             }
  63             return $value;
  64         }
  65
  66         if (is_object($value)) {
  67             if (!(self::RECURSE_OBJECT & $recurse)) {
  68                 // Attempt to cast it to a string
  69                 if (method_exists($value, '__toString')) {
  70                     return $this->escape((string) $value);
  71                 }
  72                 throw new Exception\InvalidArgumentException(
  73                     'Object provided to Escape helper, but flags do not allow recursion'
  74                 );
  75             }
  76             if (method_exists($value, 'toArray')) {
  77                 return $this->__invoke($value->toArray(), $recurse | self::RECURSE_ARRAY);
  78             }
  79             return $this->__invoke((array) $value, $recurse | self::RECURSE_ARRAY);
  80         }
  81
  82         return $value;
  83     }
  84
  85     /**
  86      * Escape a value for current escaping strategy
  87      *
  88      * @param  string $value
  89      * @return string
  90      */
  91     abstract protected function escape($value);
  92
  93     /**
  94      * Set the encoding to use for escape operations
  95      *
  96      * @param  string $encoding
  97      * @throws Exception\InvalidArgumentException
  98      * @return AbstractHelper
  99      */
 100     public function setEncoding($encoding)
 101     {
 102         if (null !== $this->escaper) {
 103             throw new Exception\InvalidArgumentException(
 104                 'Character encoding settings cannot be changed once the Helper has been used or '
 105                 . ' if a Zend\Escaper\Escaper object (with preset encoding option) is set.'
 106             );
 107         }
 108
 109         $this->encoding = $encoding;
 110
 111         return $this;
 112     }
 113
 114     /**
 115      * Get the encoding to use for escape operations
 116      *
 117      * @return string
 118      */
 119     public function getEncoding()
 120     {
 121         return $this->encoding;
 122     }
 123
 124     /**
 125      * Set instance of Escaper
 126      *
 127      * @param  Escaper\Escaper $escaper
 128      * @return AbstractHelper
 129      */
 130     public function setEscaper(Escaper\Escaper $escaper)
 131     {
 132         $this->escaper  = $escaper;
 133         $this->encoding = $escaper->getEncoding();
 134
 135         return $this;
 136     }
 137
 138     /**
 139      * Get instance of Escaper
 140      *
 141      * @return null|Escaper\Escaper
 142      */
 143     public function getEscaper()
 144     {
 145         if (null === $this->escaper) {
 146             $this->setEscaper(new Escaper\Escaper($this->getEncoding()));
 147         }
 148
 149         return $this->escaper;
 150     }
 151 }