HTMLPurifier_URIDefinition
extends HTMLPurifier_Definition
in package
Super-class for definition datatype objects, implements serialization functions for the class.
Table of Contents
Properties
- $base : mixed
- HTMLPurifier_URI object of the base specified at %URI.Base
- $defaultScheme : mixed
- Name of default scheme based on %URI.DefaultScheme and %URI.Base
- $host : mixed
- String host to consider "home" base, derived off of $base
- $optimized : mixed
- 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.
- $setup : mixed
- Has setup() been called yet?
- $type : mixed
- What type of definition is it?
- $filters : mixed
- $postFilters : mixed
- $registeredFilters : mixed
Methods
- __construct() : mixed
- addFilter() : mixed
- filter() : mixed
- getDefaultScheme() : mixed
- postFilter() : mixed
- registerFilter() : mixed
- setup() : mixed
- Setup function that aborts if already setup
- doSetup() : mixed
- Sets up the definition object into the final form, something not done by the constructor
- setupFilters() : mixed
- setupMemberVariables() : mixed
Properties
$base
HTMLPurifier_URI object of the base specified at %URI.Base
public
mixed
$base
$defaultScheme
Name of default scheme based on %URI.DefaultScheme and %URI.Base
public
mixed
$defaultScheme
$host
String host to consider "home" base, derived off of $base
public
mixed
$host
$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.
public
mixed
$optimized
= \null
Tags
$setup
Has setup() been called yet?
public
mixed
$setup
= \false
Tags
$type
What type of definition is it?
public
mixed
$type
= 'URI'
$filters
protected
mixed
$filters
= array()
$postFilters
protected
mixed
$postFilters
= array()
$registeredFilters
protected
mixed
$registeredFilters
= array()
Methods
__construct()
public
__construct() : mixed
addFilter()
public
addFilter(mixed $filter, mixed $config) : mixed
Parameters
- $filter : mixed
- $config : mixed
filter()
public
filter(mixed &$uri, mixed $config, mixed $context) : mixed
Parameters
- $uri : mixed
- $config : mixed
- $context : mixed
getDefaultScheme()
public
getDefaultScheme(mixed $config, mixed $context) : mixed
Parameters
- $config : mixed
- $context : mixed
postFilter()
public
postFilter(mixed &$uri, mixed $config, mixed $context) : mixed
Parameters
- $uri : mixed
- $config : mixed
- $context : mixed
registerFilter()
public
registerFilter(mixed $filter) : mixed
Parameters
- $filter : mixed
setup()
Setup function that aborts if already setup
public
setup(HTMLPurifier_Config $config) : mixed
Parameters
- $config : HTMLPurifier_Config
doSetup()
Sets up the definition object into the final form, something not done by the constructor
protected
doSetup(mixed $config) : mixed
Parameters
- $config : mixed
setupFilters()
protected
setupFilters(mixed $config) : mixed
Parameters
- $config : mixed
setupMemberVariables()
protected
setupMemberVariables(mixed $config) : mixed
Parameters
- $config : mixed