API Documentation

Filter/StripTags.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: StripTags.php 22548 2010-07-11 12:48:34Z thomas $
Classes
Zend_Filter_StripTags

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_StripTags

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
Constants
UNIQUE_ID_PREFIX
Properties
$commentsAllowed
$_tagsAllowed
$_attributesAllowed
Methods
__construct
getCommentsAllowed
setCommentsAllowed
getTagsAllowed
setTagsAllowed
getAttributesAllowed
setAttributesAllowed
filter
_filterTag

Description

Constants

UNIQUE_ID_PREFIX

 UNIQUE_ID_PREFIX = '__Zend_Filter_StripTags__'

Unique ID prefix used for allowing comments

Details

value
__Zend_Filter_StripTags__

Properties

$_attributesAllowed

array $_attributesAllowed = 'array'

Array of allowed attributes for all allowed tags

Attributes stored here are allowed for all of the allowed tags.

Details

$_attributesAllowed
array
visibility
protected
default
array
final
false
static
false

$_tagsAllowed

array $_tagsAllowed = 'array'

Array of allowed tags and allowed attributes for each allowed tag

Tags are stored in the array keys, and the array values are themselves arrays of the attributes allowed for the corresponding tag.

Details

$_tagsAllowed
array
visibility
protected
default
array
final
false
static
false

$commentsAllowed

boolean $commentsAllowed = 'false'

Whether comments are allowed

If false (the default), then comments are removed from the input string.

This setting is now deprecated, and ignored internally.

Details

$commentsAllowed
boolean
visibility
public
default
false
final
false
static
false
deprecated

Methods

__construct

__construct( string|array|Zend_Config $options = null ) : void

Sets the filter options Allowed options are 'allowTags' => Tags which are allowed 'allowAttribs' => Attributes which are allowed 'allowComments' => Are comments allowed ?

Arguments
$options
stringarrayZend_Config
Details
visibility
public
final
false
static
false

_filterTag

_filterTag( string $tag ) : string

Filters a single tag against the current option settings

Arguments
$tag
string
Output
string
Details
visibility
protected
final
false
static
false

filter

filter( string $value ) : string

Defined by Zend_Filter_Interface

Arguments
$value
string
Output
string
Details
visibility
public
final
false
static
false
todo
improve docblock descriptions

getAttributesAllowed

getAttributesAllowed( ) : array

Returns the attributesAllowed option

Output
array
Details
visibility
public
final
false
static
false

getCommentsAllowed

getCommentsAllowed( ) : bool

Returns the commentsAllowed option

This setting is now deprecated and ignored internally.

Output
bool
Details
visibility
public
final
false
static
false
deprecated

getTagsAllowed

getTagsAllowed( ) : array

Returns the tagsAllowed option

Output
array
Details
visibility
public
final
false
static
false

setAttributesAllowed

setAttributesAllowed( array|string $attributesAllowed ) : Zend_Filter_StripTags

Sets the attributesAllowed option

Arguments
$attributesAllowed
arraystring
Output
Zend_Filter_StripTags
Provides a fluent interface
Details
visibility
public
final
false
static
false

setCommentsAllowed

setCommentsAllowed( boolean $commentsAllowed ) : Zend_Filter_StripTags

Sets the commentsAllowed option

This setting is now deprecated and ignored internally.

Arguments
$commentsAllowed
boolean
Output
Zend_Filter_StripTags
Provides a fluent interface
Details
visibility
public
final
false
static
false
deprecated

setTagsAllowed

setTagsAllowed( array|string $tagsAllowed ) : Zend_Filter_StripTags

Sets the tagsAllowed option

Arguments
$tagsAllowed
arraystring
Output
Zend_Filter_StripTags
Provides a fluent interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.