Inheritance diagram for HTMLPurifier_URIFilter:

[legend]

Public Member Functions
	prepare ($config)

	filter (&$uri, $config, $context)

Data Fields
	$name

	$post = false

	$always_load = false

Detailed Description

Chainable filters for custom URI processing.

These filters can perform custom actions on a URI filter object, including transformation or blacklisting. A filter named Foo must have a corresponding configuration directive URI.Foo, unless always_load is specified to be true.

The following contexts may be available while URIFilters are being processed:

 - EmbeddedURI: true if URI is an embedded resource that will
   be loaded automatically on page load
 - CurrentToken: a reference to the token that is currently
   being processed
 - CurrentAttr: the name of the attribute that is currently being
   processed
 - CurrentCSSProperty: the name of the CSS property that is
   currently being processed (if applicable)

Warning: This filter is called before scheme object validation occurs. Make sure, if you require a specific scheme object, you you check that it exists. This allows filters to convert proprietary URI schemes into regular ones.

Member Function Documentation

◆ filter()

filter	(	&	$uri,
			$config,
			$context
	)

abstract

Filter a URI object

Parameters

HTMLPurifier_URI	$uri	Reference to URI object variable
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool 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

Reimplemented in HTMLPurifier_URIFilter_DisableExternal, HTMLPurifier_URIFilter_DisableExternalResources, HTMLPurifier_URIFilter_DisableResources, HTMLPurifier_URIFilter_HostBlacklist, HTMLPurifier_URIFilter_MakeAbsolute, HTMLPurifier_URIFilter_Munge, and HTMLPurifier_URIFilter_SafeIframe.

◆ prepare()

prepare ( $config )

Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.

Parameters

HTMLPurifier_Config $config

Returns: bool

Reimplemented in HTMLPurifier_URIFilter_DisableExternal, HTMLPurifier_URIFilter_HostBlacklist, HTMLPurifier_URIFilter_MakeAbsolute, HTMLPurifier_URIFilter_Munge, and HTMLPurifier_URIFilter_SafeIframe.

Field Documentation

◆ $always_load

$always_load = false

True if this filter should always be loaded. This permits a filter to be named Foo without the corresponding URI.Foo directive existing. @type bool

◆ $name

$name

Unique identifier of filter. @type string

◆ $post

$post = false

True if this filter should be run after scheme validation. @type bool

The documentation for this class was generated from the following file:

C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/URIFilter.php

Public Member Functions

Data Fields