Klassendiagramm für HTMLPurifier_URIFilter:

[Legende]

Öffentliche Methoden
	prepare ($config)

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

Datenfelder
	$name

	$post = false

	$always_load = false

Ausführliche Beschreibung

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)

Warnung: 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.

Definiert in Zeile 28 der Datei URIFilter.php.

Dokumentation der Elementfunktionen

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

abstract

Filter a URI object

Parameter

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

Rückgabe: 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

prepare ( $config)

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

Parameter

HTMLPurifier_Config $config