Docs For Class HTMLPurifier

Description

Configuration definition, defines directives and their defaults.

Located in /lib/core/Parsers/htmlpurifier/HTMLPurifier.standalone.php (line 1887)

Variable Summary

static mixed $singleton

mixed $defaultPlist

mixed $defaults

mixed $info

Method Summary

static void instance ([ $prototype = null])

static void makeFromSerial ()

HTMLPurifier_ConfigSchema __construct ()

void add ($namespace $key, $name $default, $default $type, $type $allow_null, $allow_null 4)

void addAlias ($namespace $key, $name $new_key, $new_namespace 2, $new_name 3)

void addAllowedValues ($namespace $key, $name $allowed, $allowed 2)

void addValueAliases ($namespace $key, $name $aliases, $aliases 2)

void postProcess ()

Variables

static mixed $singleton (line 1934)

Application-wide singleton

access: protected

mixed $defaultPlist (line 1898)

The default property list. Do not edit this property list.

access: public

mixed $defaults = array() (line 1893)

Defaults of the directives and namespaces.

access: public

mixed $info = array() (line 1929)

Definition of the directives. The structure of this is:

array( 'Namespace' => array( 'Directive' => new stdclass(), ) )

The stdclass may have the following properties:

type: Integer type of directive, see HTMLPurifier_VarParser for definitions
allow_null: If set, this directive allows null values
aliases: If set, an associative array of value aliases to real values

namespace: Namespace this directive aliases to
name: Directive name this directive aliases to

In certain degenerate cases, stdclass will actually be an integer. In that case, the value is equivalent to an stdclass with the type property set to the integer. If the integer is negative, type is equal to the absolute value of integer, and allow_null is true.

This class is friendly with HTMLPurifier_Config. If you need introspection about the schema, you're better of using the ConfigSchema_Interchange, which uses more memory but has much richer information.

access: public

Methods

static method instance (line 1950)

Retrieves an instance of the application-wide configuration definition.

access: public

static void instance ([ $prototype = null])

$prototype

static method makeFromSerial (line 1943)

Unserializes the default ConfigSchema.

access: public

static void makeFromSerial ()

Constructor __construct (line 1936)

access: public

HTMLPurifier_ConfigSchema __construct ()

add (line 1971)

Defines a directive for configuration

access: public

void add ($namespace $key, $name $default, $default $type, $type $allow_null, $allow_null 4)

$allow_null 4: Whether or not to allow null values
$namespace $key: Namespace the directive is in
$name $default: Key of directive
$default $type: Default value of directive
$type $allow_null: Allowed type of the directive. See HTMLPurifier_DirectiveDef::$type for allowed values

addAlias (line 2017)

Defines a directive alias for backwards compatibility

access: public

void addAlias ($namespace $key, $name $new_key, $new_namespace 2, $new_name 3)

$new_namespace 2
$new_name 3: Directive that the alias will be to
$namespace $key
$name $new_key: Directive that will be aliased

addAllowedValues (line 2006)

Defines a set of allowed values for a directive.

access: public

void addAllowedValues ($namespace $key, $name $allowed, $allowed 2)

$allowed 2: Lookup array of allowed values
$namespace $key: Namespace of directive
$name $allowed: Name of directive

addValueAliases (line 1989)

Defines a directive value alias.

Directive value aliases are convenient for developers because it lets them set a directive to several values and get the same result.

access: public

void addValueAliases ($namespace $key, $name $aliases, $aliases 2)

$aliases 2: Hash of aliased values to the real alias
$namespace $key: Directive's namespace
$name $aliases: Name of Directive

postProcess (line 2027)

Replaces any stdclass that only has the type property with type integer.

access: public

void postProcess ()

Class HTMLPurifier_ConfigSchema