| package |
Default |
| inherited_from |
\Zend\Filter\AbstractFilter |
Methods
Sets the filter options
Allowed options are
'allowTags' => Tags which are allowed
'allowAttribs' => Attributes which are allowed
'allowComments' => Are comments allowed ?
__construct(string|array|\Traversable $options = null)
Parameters
$options
stringarray\Traversable
Invoke filter as a command
__invoke(mixed $value) : mixed
Inherited
Parameters
$value
mixed
Exceptions
\Zend\Filter\Exception\ExceptionInterface |
If filtering $value is impossible |
Returns
mixed
Defined by Zend\Filter\FilterInterface
filter(string $value) : string | mixed
If the value provided is non-scalar, the value will remain unfiltered
| todo |
improve docblock descriptions |
Parameters
$value
string
Returns
stringmixed
Returns the attributesAllowed option
getAttributesAllowed() : array
Retrieve options representing object state
getOptions() : array
Inherited
hasPcreUnicodeSupport()
hasPcreUnicodeSupport() : boolean
InheritedStatic
Sets the attributesAllowed option
setAttributesAllowed(array|string $attributesAllowed) : \Zend\Filter\StripTags
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$attributesAllowed
arraystring
Returns
\Zend\Filter\StripTagsProvides a fluent interface
setOptions()
setOptions(array|\Traversable $options) : \Zend\Filter\StripTags
Inherited
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$options
array\Traversable
Exceptions
\Zend\Filter\Exception\InvalidArgumentException |
|
Returns
\Zend\Filter\StripTags
Filters a single tag against the current option settings
_filterTag(string $tag) : string
Parameters
$tag
string
Returns
string
isOptions()
isOptions(mixed $options) : boolean
InheritedStatic
Parameters
$options
mixed
Returns
boolean
Properties
Array of allowed attributes for all allowed tags
$attributesAllowed : array
Attributes stored here are allowed for all of the allowed tags.
Filter options
$options : array
Constants
Unique ID prefix used for allowing comments
UNIQUE_ID_PREFIX = '__Zend_Filter_StripTags__'