Filter/HtmlEntities.php

Show: PublicProtectedPrivateinherited
Table of Contents
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  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Filter  
Version
$Id: HtmlEntities.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Filter_HtmlEntities

Package: Zend\Filter
Implements
\Zend_Filter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\unknown_type $_doubleQuote
Corresponds to the forth htmlentities() argument
Details
Type
\unknown_type
>VPropertyprotectedstring $_encoding
Corresponds to the third htmlentities() argument
Details
Type
string
>VPropertyprotectedinteger $_quoteStyle
Corresponds to the second htmlentities() argument
Details
Type
integer

Methods

methodpublic__construct( $options = array()) : void

Sets filter options

Parameters
NameTypeDescription
$options
methodpublicfilter(string $value) : string

Defined by Zend_Filter_Interface

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

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Filter_ExceptionIf filtering $value is impossible
methodpublicgetCharSet() : string

Returns the charSet option

Proxies to getEncoding()

Returns
TypeDescription
string
methodpublicgetDoubleQuote() : boolean

Returns the doubleQuote option

Returns
TypeDescription
boolean
methodpublicgetEncoding() : string

Get encoding

Returns
TypeDescription
string
methodpublicgetQuoteStyle() : integer

Returns the quoteStyle option

Returns
TypeDescription
integer
methodpublicsetCharSet(string $charSet) : \Zend_Filter_HtmlEntities

Sets the charSet option

Proxies to setEncoding()

Parameters
NameTypeDescription
$charSetstring
Returns
TypeDescription
\Zend_Filter_HtmlEntitiesProvides a fluent interface
methodpublicsetDoubleQuote(boolean $doubleQuote) : \Zend_Filter_HtmlEntities

Sets the doubleQuote option

Parameters
NameTypeDescription
$doubleQuoteboolean
Returns
TypeDescription
\Zend_Filter_HtmlEntitiesProvides a fluent interface
methodpublicsetEncoding(string $value) : \Zend_Filter_HtmlEntities

Set encoding

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Filter_HtmlEntities
methodpublicsetQuoteStyle(integer $quoteStyle) : \Zend_Filter_HtmlEntities

Sets the quoteStyle option

Parameters
NameTypeDescription
$quoteStyleinteger
Returns
TypeDescription
\Zend_Filter_HtmlEntitiesProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.