• Home
  • HTMLPurifier_URIFilter

PHP Class HTMLPurifier_URIFilter, yii

These filters can perform custom actions on a URI filter object, including transformation or blacklisting.
显示文件 Open project: yiisoft/yii

Public Properties

Property Type Description
$always_load This permits a filter to be named Foo without the corresponding %URI.Foo directive existing.
$name Unique identifier of filter.
$post True if this filter should be run after scheme validation.

Public Methods

Method Description
filter ( HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : boolean Filter a URI object
prepare ( HTMLPurifier_Config $config ) : boolean Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.

Method Details

filter() abstract public method

Filter a URI object
abstract public filter ( HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : boolean
$uri HTMLPurifier_URI Reference to URI object variable
$config HTMLPurifier_Config
$context HTMLPurifier_Context
return boolean Whether or not to continue processing: false indicates URL is no good, true indicates continue processing. Note that all changes are committed directly on the URI object

prepare() public method

Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.
public prepare ( HTMLPurifier_Config $config ) : boolean
$config HTMLPurifier_Config
return boolean

Property Details

$always_load public_oe property

This permits a filter to be named Foo without the corresponding %URI.Foo directive existing.
public $always_load

$name public_oe property

Unique identifier of filter.
public $name

$post public_oe property

True if this filter should be run after scheme validation.
public $post