Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
HTMLPurifier_URIFilter Class Reference
Inheritance diagram for HTMLPurifier_URIFilter:
HTMLPurifier_URIFilter_DisableExternal HTMLPurifier_URIFilter_DisableResources HTMLPurifier_URIFilter_HostBlacklist HTMLPurifier_URIFilter_MakeAbsolute HTMLPurifier_URIFilter_Munge HTMLPurifier_URIFilter_SafeIframe HTMLPurifier_URIFilter_DisableExternalResources

Public Member Functions

 filter (&$uri, $config, $context)
 Filter a URI object.
 
 prepare ($config)
 Performs initialization for the filter.
 

Public Attributes

 $always_load = false
 True if this filter should always be loaded.
 
 $name
 Unique identifier of filter.
 
 $post = false
 True if this filter should be run after scheme validation.
 

Member Function Documentation

◆ filter()

HTMLPurifier_URIFilter::filter ( & $uri,
$config,
$context )
abstract

Filter a URI object.

Parameters
HTMLPurifier_URI$uriReference to URI object variable
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Return values
boolWhether 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()

HTMLPurifier_URIFilter::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
Return values
bool

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

Member Data Documentation

◆ $always_load

HTMLPurifier_URIFilter::$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

HTMLPurifier_URIFilter::$name

Unique identifier of filter.

@type string

◆ $post

HTMLPurifier_URIFilter::$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: