ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
HTMLPurifier_URIFilter Class Reference

Chainable filters for custom URI processing. More...

+ Inheritance diagram for HTMLPurifier_URIFilter:
+ Collaboration diagram for HTMLPurifier_URIFilter:

Public Member Functions

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

Data Fields

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

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.

Definition at line 28 of file URIFilter.php.

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
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

Referenced by prepare().

+ Here is the caller graph for this function:

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

Definition at line 57 of file URIFilter.php.

References filter().

58  {
59  return true;
60  }
+ Here is the call graph for this function:

Field 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. bool

Definition at line 49 of file URIFilter.php.

◆ $name

HTMLPurifier_URIFilter::$name

Unique identifier of filter.

string

Definition at line 35 of file URIFilter.php.

◆ $post

HTMLPurifier_URIFilter::$post = false

True if this filter should be run after scheme validation.

bool

Definition at line 41 of file URIFilter.php.


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