\HTMLPurifier_URIDefinition

Super-class for definition datatype objects, implements serialization functions for the class.

Summary

Methods
Properties
Constants
setup()
__construct()
registerFilter()
addFilter()
getDefaultScheme()
filter()
postFilter()
$setup
$optimized
$type
$base
$host
$defaultScheme
No constants found
doSetup()
setupFilters()
setupMemberVariables()
$filters
$postFilters
$registeredFilters
N/A
No private methods found
No private properties found
N/A

Properties

$setup

$setup : 

Has setup() been called yet?

Type

$optimized

$optimized : 

If true, write out the final definition object to the cache after setup. This will be true only if all invocations to get a raw definition object are also optimized. This does not cause file system thrashing because on subsequent calls the cached object is used and any writes to the raw definition object are short circuited. See enduser-customize.html for the high-level picture.

Type

$type

$type : 

What type of definition is it?

Type

$base

$base : 

HTMLPurifier_URI object of the base specified at %URI.Base

Type

$host

$host : 

String host to consider "home" base, derived off of $base

Type

$defaultScheme

$defaultScheme : 

Name of default scheme based on %URI.DefaultScheme and %URI.Base

Type

$filters

$filters : 

Type

$postFilters

$postFilters : 

Type

$registeredFilters

$registeredFilters : 

Type

Methods

setup()

setup(\HTMLPurifier_Config  $config) 

Setup function that aborts if already setup

Parameters

\HTMLPurifier_Config $config

__construct()

__construct() 

registerFilter()

registerFilter(  $filter) 

Parameters

$filter

addFilter()

addFilter(  $filter,   $config) 

Parameters

$filter
$config

getDefaultScheme()

getDefaultScheme(  $config,   $context) 

Parameters

$config
$context

filter()

filter(  $uri,   $config,   $context) 

Parameters

$uri
$config
$context

postFilter()

postFilter(  $uri,   $config,   $context) 

Parameters

$uri
$config
$context

doSetup()

doSetup(\HTMLPurifier_Config  $config) 

Sets up the definition object into the final form, something not done by the constructor

Parameters

\HTMLPurifier_Config $config

setupFilters()

setupFilters(  $config) 

Parameters

$config

setupMemberVariables()

setupMemberVariables(  $config) 

Parameters

$config