web/Zend/Filter/HtmlEntities.php
changeset 0 4eba9c11703f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/Zend/Filter/HtmlEntities.php	Mon Dec 13 18:29:26 2010 +0100
@@ -0,0 +1,202 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Filter
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id: HtmlEntities.php 21060 2010-02-15 21:56:07Z thomas $
+ */
+
+/**
+ * @see Zend_Filter_Interface
+ */
+require_once 'Zend/Filter/Interface.php';
+
+/**
+ * @category   Zend
+ * @package    Zend_Filter
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class Zend_Filter_HtmlEntities implements Zend_Filter_Interface
+{
+    /**
+     * Corresponds to the second htmlentities() argument
+     *
+     * @var integer
+     */
+    protected $_quoteStyle;
+
+    /**
+     * Corresponds to the third htmlentities() argument
+     *
+     * @var string
+     */
+    protected $_encoding;
+
+    /**
+     * Corresponds to the forth htmlentities() argument
+     *
+     * @var unknown_type
+     */
+    protected $_doubleQuote;
+
+    /**
+     * Sets filter options
+     *
+     * @param  integer|array $quoteStyle
+     * @param  string  $charSet
+     * @return void
+     */
+    public function __construct($options = array())
+    {
+        if ($options instanceof Zend_Config) {
+            $options = $options->toArray();
+        } else if (!is_array($options)) {
+            $options = func_get_args();
+            $temp['quotestyle'] = array_shift($options);
+            if (!empty($options)) {
+                $temp['charset'] = array_shift($options);
+            }
+
+            $options = $temp;
+        }
+
+        if (!isset($options['quotestyle'])) {
+            $options['quotestyle'] = ENT_COMPAT;
+        }
+
+        if (!isset($options['encoding'])) {
+            $options['encoding'] = 'UTF-8';
+        }
+        if (isset($options['charset'])) {
+            $options['encoding'] = $options['charset'];
+        }
+
+        if (!isset($options['doublequote'])) {
+            $options['doublequote'] = true;
+        }
+
+        $this->setQuoteStyle($options['quotestyle']);
+        $this->setEncoding($options['encoding']);
+        $this->setDoubleQuote($options['doublequote']);
+    }
+
+    /**
+     * Returns the quoteStyle option
+     *
+     * @return integer
+     */
+    public function getQuoteStyle()
+    {
+        return $this->_quoteStyle;
+    }
+
+    /**
+     * Sets the quoteStyle option
+     *
+     * @param  integer $quoteStyle
+     * @return Zend_Filter_HtmlEntities Provides a fluent interface
+     */
+    public function setQuoteStyle($quoteStyle)
+    {
+        $this->_quoteStyle = $quoteStyle;
+        return $this;
+    }
+
+
+    /**
+     * Get encoding
+     *
+     * @return string
+     */
+    public function getEncoding()
+    {
+         return $this->_encoding;
+    }
+
+    /**
+     * Set encoding
+     *
+     * @param  string $value
+     * @return Zend_Filter_HtmlEntities
+     */
+    public function setEncoding($value)
+    {
+        $this->_encoding = (string) $value;
+        return $this;
+    }
+
+    /**
+     * Returns the charSet option
+     *
+     * Proxies to {@link getEncoding()}
+     *
+     * @return string
+     */
+    public function getCharSet()
+    {
+        return $this->getEncoding();
+    }
+
+    /**
+     * Sets the charSet option
+     *
+     * Proxies to {@link setEncoding()}
+     *
+     * @param  string $charSet
+     * @return Zend_Filter_HtmlEntities Provides a fluent interface
+     */
+    public function setCharSet($charSet)
+    {
+        return $this->setEncoding($charSet);
+    }
+
+    /**
+     * Returns the doubleQuote option
+     *
+     * @return boolean
+     */
+    public function getDoubleQuote()
+    {
+        return $this->_doubleQuote;
+    }
+
+    /**
+     * Sets the doubleQuote option
+     *
+     * @param boolean $doubleQuote
+     * @return Zend_Filter_HtmlEntities Provides a fluent interface
+     */
+    public function setDoubleQuote($doubleQuote)
+    {
+        $this->_doubleQuote = (boolean) $doubleQuote;
+        return $this;
+    }
+
+    /**
+     * Defined by Zend_Filter_Interface
+     *
+     * Returns the string $value, converting characters to their corresponding HTML entity
+     * equivalents where they exist
+     *
+     * @param  string $value
+     * @return string
+     */
+    public function filter($value)
+    {
+        return htmlentities((string) $value, $this->getQuoteStyle(), $this->getEncoding(), $this->getDoubleQuote());
+    }
+}