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

$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

What type of definition is it?

$base

$base

HTMLPurifier_URI object of the base specified at %URI.Base

$host

$host

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

$defaultScheme

$defaultScheme

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

$filters

$filters

$postFilters

$postFilters

$registeredFilters

$registeredFilters

Methods

setup()

setup(\HTMLPurifier_Config  $config) : mixed

Setup function that aborts if already setup

Parameters

\HTMLPurifier_Config $config

Returns

mixed —

__construct()

__construct() : mixed

Returns

mixed —

registerFilter()

registerFilter(mixed  $filter) : mixed

Parameters

mixed $filter

Returns

mixed —

addFilter()

addFilter(mixed  $filter, mixed  $config) : mixed

Parameters

mixed $filter
mixed $config

Returns

mixed —

getDefaultScheme()

getDefaultScheme(mixed  $config, mixed  $context) : mixed

Parameters

mixed $config
mixed $context

Returns

mixed —

filter()

filter(mixed  $uri, mixed  $config, mixed  $context) : mixed

Parameters

mixed $uri
mixed $config
mixed $context

Returns

mixed —

postFilter()

postFilter(mixed  $uri, mixed  $config, mixed  $context) : mixed

Parameters

mixed $uri
mixed $config
mixed $context

Returns

mixed —

doSetup()

doSetup(mixed  $config) : mixed

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

Parameters

mixed $config

Returns

mixed —

setupFilters()

setupFilters(mixed  $config) : mixed

Parameters

mixed $config

Returns

mixed —

setupMemberVariables()

setupMemberVariables(mixed  $config) : mixed

Parameters

mixed $config

Returns

mixed —