API Documentation

Zend/Filter/HtmlEntities.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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

Propertyprotected\unknown_type  $_doubleQuote= ''

Corresponds to the forth htmlentities() argument

Details
Type
\unknown_type
Propertyprotectedstring  $_encoding= ''

Corresponds to the third htmlentities() argument

Details
Type
string
Propertyprotectedinteger  $_quoteStyle= ''

Corresponds to the second htmlentities() argument

Details
Type
integer

Methods

methodpublic__construct(  $options = array() ) : void

Sets filter options

Parameters
Name Type Description
$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
Name Type Description
$value string
Returns
Type Description
string
methodpublicgetCharSet( ) : string

Returns the charSet option

Proxies to {@link getEncoding()}

Returns
Type Description
string
methodpublicgetDoubleQuote( ) : boolean

Returns the doubleQuote option

Returns
Type Description
boolean
methodpublicgetEncoding( ) : string

Get encoding

Returns
Type Description
string
methodpublicgetQuoteStyle( ) : integer

Returns the quoteStyle option

Returns
Type Description
integer
methodpublicsetCharSet( string $charSet ) : \Zend_Filter_HtmlEntities

Sets the charSet option

Proxies to {@link setEncoding()}

Parameters
Name Type Description
$charSet string
Returns
Type Description
\Zend_Filter_HtmlEntities Provides a fluent interface
methodpublicsetDoubleQuote( boolean $doubleQuote ) : \Zend_Filter_HtmlEntities

Sets the doubleQuote option

Parameters
Name Type Description
$doubleQuote boolean
Returns
Type Description
\Zend_Filter_HtmlEntities Provides a fluent interface
methodpublicsetEncoding( string $value ) : \Zend_Filter_HtmlEntities

Set encoding

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Filter_HtmlEntities
methodpublicsetQuoteStyle( integer $quoteStyle ) : \Zend_Filter_HtmlEntities

Sets the quoteStyle option

Parameters
Name Type Description
$quoteStyle integer
Returns
Type Description
\Zend_Filter_HtmlEntities Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.