Skip to content

HTMLPurifier_ConfigSchema_Interchange_Directive

Interchange component class describing configuration directives.

  • Full name: \HTMLPurifier_ConfigSchema_Interchange_Directive

Properties

id

ID of directive.

public $id

type

Type, e.g. 'integer' or 'istring'.

public $type

default

Default value, e.g. 3 or 'DefaultVal'.

public $default

description

HTML description.

public $description

typeAllowsNull

Whether or not null is allowed as a value.

public $typeAllowsNull

allowed

Lookup table of allowed scalar values.

public $allowed

e.g. array('allowed' => true). Null if all values are allowed.


aliases

List of aliases for the directive.

public $aliases

e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))).


valueAliases

Hash of value aliases, e.g. array('alt' => 'real'). Null if value aliasing is disabled (necessary for non-scalar types).

public $valueAliases

version

Version of HTML Purifier the directive was introduced, e.g. '1.3.1'.

public $version

Null if the directive has always existed.


deprecatedUse

ID of directive that supercedes this old directive.

public $deprecatedUse

Null if not deprecated.


deprecatedVersion

Version of HTML Purifier this directive was deprecated. Null if not deprecated.

public $deprecatedVersion

external

List of external projects this directive depends on, e.g. array('CSSTidy').

public $external


Automatically generated on 2025-03-18