Filter/StripTags.php

Show:

inherited

Classes
- \Zend_Filter_StripTags

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: StripTags.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_StripTags
jump to top

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

Constants

 
                UNIQUE_ID_PREFIX
                = '__Zend_Filter_StripTags__'

Unique ID prefix used for allowing comments

Properties

array $_attributesAllowed = array()

Array of allowed attributes for all allowed tags

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

Default valuearray()Details

Type: array

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.

Default valuearray()Details

Type: array

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.

Default valuefalseDetails

Type: boolean
Deprecated

Methods

__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 ?

Parameters

Name	Type	Description
$options	string \| array \| \Zend_Config

_filterTag(string $tag) : string

Filters a single tag against the current option settings

Parameters

Name	Type	Description
$tag	string

Returns

Type	Description
string

filter(string $value) : string

Defined by Zend_Filter_Interface

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Filter_Exception	If filtering $value is impossible

Details

Todo: improve docblock descriptions

getAttributesAllowed() : array

Returns the attributesAllowed option

Returns

Type	Description
array

getCommentsAllowed() : bool

Returns the commentsAllowed option

This setting is now deprecated and ignored internally.

Returns

Type	Description
bool

Details

Deprecated

getTagsAllowed() : array

Returns the tagsAllowed option

Returns

Type	Description
array

setAttributesAllowed(array | string $attributesAllowed) : \Zend_Filter_StripTags

Sets the attributesAllowed option

Parameters

Name	Type	Description
$attributesAllowed	array \| string

Returns

Type	Description
\Zend_Filter_StripTags	Provides a fluent interface

setCommentsAllowed(boolean $commentsAllowed) : \Zend_Filter_StripTags

Sets the commentsAllowed option

This setting is now deprecated and ignored internally.

Parameters

Name	Type	Description
$commentsAllowed	boolean

Returns

Type	Description
\Zend_Filter_StripTags	Provides a fluent interface

Details

Deprecated

setTagsAllowed(array | string $tagsAllowed) : \Zend_Filter_StripTags

Sets the tagsAllowed option

Parameters

Name	Type	Description
$tagsAllowed	array \| string

Returns

Type	Description
\Zend_Filter_StripTags	Provides a fluent interface

Filter/StripTags.php

\Zend_Filter_StripTagsjump to top

Constants

Properties

Methods

\Zend_Filter_StripTags
jump to top