Zend_Filter_HtmlEntities Class Reference

Inheritance diagram for Zend_Filter_HtmlEntities:

Public Member Functions
	__construct ($options=array())
	getQuoteStyle ()
	setQuoteStyle ($quoteStyle)
	getEncoding ()
	setEncoding ($value)
	getCharSet ()
	setCharSet ($charSet)
	getDoubleQuote ()
	setDoubleQuote ($doubleQuote)
	filter ($value)

Protected Attributes
	$_quoteStyle
	$_encoding
	$_doubleQuote

Detailed Description

Definition at line 33 of file HtmlEntities.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Sets filter options

Parameters

integer | array	$quoteStyle
string	$charSet

Returns

void

Definition at line 63 of file HtmlEntities.php.

    {
        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']);
    }

Member Function Documentation

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Returns the string $value, converting characters to their corresponding HTML entity equivalents where they exist

Parameters

string

$value

Returns

string

Implements Zend_Filter_Interface.

Definition at line 198 of file HtmlEntities.php.

    {
        $filtered = htmlentities((string) $value, $this->getQuoteStyle(), $this->getEncoding(), $this->getDoubleQuote());
        if (strlen((string) $value) && !strlen($filtered)) {
            if (!function_exists('iconv')) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception('Encoding mismatch has resulted in htmlentities errors');
            }
            $enc      = $this->getEncoding();
            $value    = iconv('', $enc . '//IGNORE', (string) $value);
            $filtered = htmlentities($value, $this->getQuoteStyle(), $enc, $this->getDoubleQuote());
            if (!strlen($filtered)) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception('Encoding mismatch has resulted in htmlentities errors');
            }
        }
        return $filtered;
    }

getCharSet()

getCharSet

(

)

Returns the charSet option

Proxies to getEncoding()

Returns

string

Definition at line 149 of file HtmlEntities.php.

    {
        return $this->getEncoding();
    }

getDoubleQuote()

getDoubleQuote

(

)

Returns the doubleQuote option

Returns

boolean

Definition at line 172 of file HtmlEntities.php.

    {
        return $this->_doubleQuote;
    }

getEncoding()

getEncoding

(

)

Get encoding

Returns

string

Definition at line 125 of file HtmlEntities.php.

    {
         return $this->_encoding;
    }

getQuoteStyle()

getQuoteStyle

(

)

Returns the quoteStyle option

Returns

integer

Definition at line 102 of file HtmlEntities.php.

    {
        return $this->_quoteStyle;
    }

setCharSet()

setCharSet

(

$charSet

)

Sets the charSet option

Proxies to setEncoding()

Parameters

string

$charSet

Returns

Zend_Filter_HtmlEntities Provides a fluent interface

Definition at line 162 of file HtmlEntities.php.

    {
        return $this->setEncoding($charSet);
    }

setDoubleQuote()

setDoubleQuote

(

$doubleQuote

)

Sets the doubleQuote option

Parameters

boolean

$doubleQuote

Returns

Zend_Filter_HtmlEntities Provides a fluent interface

Definition at line 183 of file HtmlEntities.php.

    {
        $this->_doubleQuote = (boolean) $doubleQuote;
        return $this;
    }

setEncoding()

setEncoding

(

$value

)

Set encoding

Parameters

string

$value

Returns

Zend_Filter_HtmlEntities

Definition at line 136 of file HtmlEntities.php.

    {
        $this->_encoding = (string) $value;
        return $this;
    }

setQuoteStyle()

setQuoteStyle

(

$quoteStyle

)

Sets the quoteStyle option

Parameters

integer

$quoteStyle

Returns

Zend_Filter_HtmlEntities Provides a fluent interface

Definition at line 113 of file HtmlEntities.php.

    {
        $this->_quoteStyle = $quoteStyle;
        return $this;
    }

Field Documentation

$_doubleQuote

$_doubleQuote

protected

Definition at line 54 of file HtmlEntities.php.

$_encoding

$_encoding

protected

Definition at line 47 of file HtmlEntities.php.

$_quoteStyle

$_quoteStyle

protected

Definition at line 40 of file HtmlEntities.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Filter/HtmlEntities.php