Filter/HtmlEntities.php
Show:
inherited
inherited
Classes
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
Parameters
Returns
Throws
Parameters
Returns
- Implements
- \Zend_Filter_Interface
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\unknown_type $_doubleQuoteCorresponds to the forth htmlentities() argument
Details
- Type
- \unknown_type
string $_encodingCorresponds to the third htmlentities() argument
Details
- Type
- string
integer $_quoteStyleCorresponds to the second htmlentities() argument
Details
- Type
- integer
Methods
__construct( $options = array()) : voidSets filter options
Parameters
| Name | Type | Description |
|---|---|---|
| $options |
filter(string $value) : stringDefined by Zend_Filter_Interface
Returns the string $value, converting characters to their corresponding HTML entity equivalents where they exist
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Filter_Exception | If filtering $value is impossible |
getDoubleQuote() : booleanReturns the doubleQuote option
Returns
| Type | Description |
|---|---|
| boolean |
getEncoding() : stringGet encoding
Returns
| Type | Description |
|---|---|
| string |
getQuoteStyle() : integerReturns the quoteStyle option
Returns
| Type | Description |
|---|---|
| integer |
setCharSet(string $charSet) : \Zend_Filter_HtmlEntitiesSets the charSet option
Proxies to setEncoding()
| Name | Type | Description |
|---|---|---|
| $charSet | string |
| Type | Description |
|---|---|
| \Zend_Filter_HtmlEntities | Provides a fluent interface |
setDoubleQuote(boolean $doubleQuote) : \Zend_Filter_HtmlEntitiesSets the doubleQuote option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $doubleQuote | boolean |
| Type | Description |
|---|---|
| \Zend_Filter_HtmlEntities | Provides a fluent interface |
setEncoding(string $value) : \Zend_Filter_HtmlEntitiesSet encoding
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Filter_HtmlEntities |
setQuoteStyle(integer $quoteStyle) : \Zend_Filter_HtmlEntitiesSets the quoteStyle option
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $quoteStyle | integer |
| Type | Description |
|---|---|
| \Zend_Filter_HtmlEntities | Provides a fluent interface |