API Documentation

Filter/HtmlEntities.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
version
$Id: HtmlEntities.php 21061 2010-02-15 21:56:54Z thomas $
Classes
Zend_Filter_HtmlEntities

Description

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.

Zend_Filter_HtmlEntities

Implements
Zend_Filter_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
Properties
$_quoteStyle
$_encoding
$_doubleQuote
Methods
__construct
getQuoteStyle
setQuoteStyle
getEncoding
setEncoding
getCharSet
setCharSet
getDoubleQuote
setDoubleQuote
filter

Description

Properties

$_doubleQuote

unknown_type $_doubleQuote = ''

Corresponds to the forth htmlentities() argument

Details

$_doubleQuote
unknown_type
visibility
protected
default
final
false
static
false

$_encoding

string $_encoding = ''

Corresponds to the third htmlentities() argument

Details

$_encoding
string
visibility
protected
default
final
false
static
false

$_quoteStyle

integer $_quoteStyle = ''

Corresponds to the second htmlentities() argument

Details

$_quoteStyle
integer
visibility
protected
default
final
false
static
false

Methods

__construct

__construct(  $options = array ) : void

Sets filter options

Arguments
$options
Details
visibility
public
final
false
static
false

filter

filter( string $value ) : string

Defined by Zend_Filter_Interface

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

Arguments
$value
string
Output
string
Details
visibility
public
final
false
static
false

getCharSet

getCharSet( ) : string

Returns the charSet option

Proxies to {@link getEncoding()}

Output
string
Details
visibility
public
final
false
static
false

getDoubleQuote

getDoubleQuote( ) : boolean

Returns the doubleQuote option

Output
boolean
Details
visibility
public
final
false
static
false

getEncoding

getEncoding( ) : string

Get encoding

Output
string
Details
visibility
public
final
false
static
false

getQuoteStyle

getQuoteStyle( ) : integer

Returns the quoteStyle option

Output
integer
Details
visibility
public
final
false
static
false

setCharSet

setCharSet( string $charSet ) : Zend_Filter_HtmlEntities

Sets the charSet option

Proxies to {@link setEncoding()}

Arguments
$charSet
string
Output
Zend_Filter_HtmlEntities
Provides a fluent interface
Details
visibility
public
final
false
static
false

setDoubleQuote

setDoubleQuote( boolean $doubleQuote ) : Zend_Filter_HtmlEntities

Sets the doubleQuote option

Arguments
$doubleQuote
boolean
Output
Zend_Filter_HtmlEntities
Provides a fluent interface
Details
visibility
public
final
false
static
false

setEncoding

setEncoding( string $value ) : Zend_Filter_HtmlEntities

Set encoding

Arguments
$value
string
Details
visibility
public
final
false
static
false

setQuoteStyle

setQuoteStyle( integer $quoteStyle ) : Zend_Filter_HtmlEntities

Sets the quoteStyle option

Arguments
$quoteStyle
integer
Output
Zend_Filter_HtmlEntities
Provides a fluent interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.