interface/modules/zend_modules/library/Zend/Filter/HtmlEntities.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\Filter;
  11
  12 use Traversable;
  13 use Zend\Stdlib\ArrayUtils;
  14
  15 class HtmlEntities extends AbstractFilter
  16 {
  17     /**
  18      * Corresponds to the second htmlentities() argument
  19      *
  20      * @var int
  21      */
  22     protected $quoteStyle;
  23
  24     /**
  25      * Corresponds to the third htmlentities() argument
  26      *
  27      * @var string
  28      */
  29     protected $encoding;
  30
  31     /**
  32      * Corresponds to the forth htmlentities() argument
  33      *
  34      * @var bool
  35      */
  36     protected $doubleQuote;
  37
  38     /**
  39      * Sets filter options
  40      *
  41      * @param array|Traversable $options
  42      */
  43     public function __construct($options = array())
  44     {
  45         if ($options instanceof Traversable) {
  46             $options = ArrayUtils::iteratorToArray($options);
  47         }
  48         if (!is_array($options)) {
  49             $options = func_get_args();
  50             $temp['quotestyle'] = array_shift($options);
  51             if (!empty($options)) {
  52                 $temp['charset'] = array_shift($options);
  53             }
  54
  55             $options = $temp;
  56         }
  57
  58         if (!isset($options['quotestyle'])) {
  59             $options['quotestyle'] = ENT_QUOTES;
  60         }
  61
  62         if (!isset($options['encoding'])) {
  63             $options['encoding'] = 'UTF-8';
  64         }
  65         if (isset($options['charset'])) {
  66             $options['encoding'] = $options['charset'];
  67         }
  68
  69         if (!isset($options['doublequote'])) {
  70             $options['doublequote'] = true;
  71         }
  72
  73         $this->setQuoteStyle($options['quotestyle']);
  74         $this->setEncoding($options['encoding']);
  75         $this->setDoubleQuote($options['doublequote']);
  76     }
  77
  78     /**
  79      * Returns the quoteStyle option
  80      *
  81      * @return int
  82      */
  83     public function getQuoteStyle()
  84     {
  85         return $this->quoteStyle;
  86     }
  87
  88     /**
  89      * Sets the quoteStyle option
  90      *
  91      * @param  int $quoteStyle
  92      * @return self Provides a fluent interface
  93      */
  94     public function setQuoteStyle($quoteStyle)
  95     {
  96         $this->quoteStyle = $quoteStyle;
  97         return $this;
  98     }
  99
 100
 101     /**
 102      * Get encoding
 103      *
 104      * @return string
 105      */
 106     public function getEncoding()
 107     {
 108          return $this->encoding;
 109     }
 110
 111     /**
 112      * Set encoding
 113      *
 114      * @param  string $value
 115      * @return self
 116      */
 117     public function setEncoding($value)
 118     {
 119         $this->encoding = (string) $value;
 120         return $this;
 121     }
 122
 123     /**
 124      * Returns the charSet option
 125      *
 126      * Proxies to {@link getEncoding()}
 127      *
 128      * @return string
 129      */
 130     public function getCharSet()
 131     {
 132         return $this->getEncoding();
 133     }
 134
 135     /**
 136      * Sets the charSet option
 137      *
 138      * Proxies to {@link setEncoding()}
 139      *
 140      * @param  string $charSet
 141      * @return self Provides a fluent interface
 142      */
 143     public function setCharSet($charSet)
 144     {
 145         return $this->setEncoding($charSet);
 146     }
 147
 148     /**
 149      * Returns the doubleQuote option
 150      *
 151      * @return bool
 152      */
 153     public function getDoubleQuote()
 154     {
 155         return $this->doubleQuote;
 156     }
 157
 158     /**
 159      * Sets the doubleQuote option
 160      *
 161      * @param  bool $doubleQuote
 162      * @return self Provides a fluent interface
 163      */
 164     public function setDoubleQuote($doubleQuote)
 165     {
 166         $this->doubleQuote = (bool) $doubleQuote;
 167         return $this;
 168     }
 169
 170     /**
 171      * Defined by Zend\Filter\FilterInterface
 172      *
 173      * Returns the string $value, converting characters to their corresponding HTML entity
 174      * equivalents where they exist
 175      *
 176      * If the value provided is non-scalar, the value will remain unfiltered
 177      * and an E_USER_WARNING will be raised indicating it's unfilterable.
 178      *
 179      * @param  string $value
 180      * @return string|mixed
 181      * @throws Exception\DomainException on encoding mismatches
 182      */
 183     public function filter($value)
 184     {
 185         if (null === $value) {
 186             return null;
 187         }
 188
 189         if (!is_scalar($value)) {
 190             trigger_error(
 191                 sprintf(
 192                     '%s expects parameter to be scalar, "%s" given; cannot filter',
 193                     __METHOD__,
 194                     (is_object($value) ? get_class($value) : gettype($value))
 195                 ),
 196                 E_USER_WARNING
 197             );
 198             return $value;
 199         }
 200
 201         $filtered = htmlentities((string) $value, $this->getQuoteStyle(), $this->getEncoding(), $this->getDoubleQuote());
 202         if (strlen((string) $value) && !strlen($filtered)) {
 203             if (!function_exists('iconv')) {
 204                 throw new Exception\DomainException('Encoding mismatch has resulted in htmlentities errors');
 205             }
 206             $enc      = $this->getEncoding();
 207             $value    = iconv('', $this->getEncoding() . '//IGNORE', (string) $value);
 208             $filtered = htmlentities($value, $this->getQuoteStyle(), $enc, $this->getDoubleQuote());
 209             if (!strlen($filtered)) {
 210                 throw new Exception\DomainException('Encoding mismatch has resulted in htmlentities errors');
 211             }
 212         }
 213         return $filtered;
 214     }
 215 }