API Documentation

Zend/Filter/StripTags.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: StripTags.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Filter_StripTags

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

Constant  UNIQUE_ID_PREFIX = '__Zend_Filter_StripTags__'

Unique ID prefix used for allowing comments

Properties

Propertyprotectedarray  $_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
Propertyprotectedarray  $_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
Propertypublicboolean  $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

methodpublic__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
methodprotected_filterTag( string $tag ) : string

Filters a single tag against the current option settings

Parameters
Name Type Description
$tag string
Returns
Type Description
string
methodpublicfilter( string $value ) : string

Defined by Zend_Filter_Interface

Parameters
Name Type Description
$value string
Returns
Type Description
string
Details
Todo
improve docblock descriptions  
methodpublicgetAttributesAllowed( ) : array

Returns the attributesAllowed option

Returns
Type Description
array
methodpublicgetCommentsAllowed( ) : bool

Returns the commentsAllowed option

This setting is now deprecated and ignored internally.

Returns
Type Description
bool
Details
Deprecated
 
methodpublicgetTagsAllowed( ) : array

Returns the tagsAllowed option

Returns
Type Description
array
methodpublicsetAttributesAllowed( 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
methodpublicsetCommentsAllowed( 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
 
methodpublicsetTagsAllowed( 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
Documentation was generated by DocBlox 0.15.1.