HTMLPurifier_ConfigSchema_Interchange_Directive Class Reference

Interchange component class describing configuration directives. More...

Collaboration diagram for HTMLPurifier_ConfigSchema_Interchange_Directive:

Data Fields
	$id
	ID of directive.
	$type
	Type, e.g.
	$default
	Default value, e.g.
	$description
	HTML description.
	$typeAllowsNull = false
	Whether or not null is allowed as a value.
	$allowed
	Lookup table of allowed scalar values.
	$aliases = array()
	List of aliases for the directive.
	$valueAliases
	Hash of value aliases, e.g.
	$version
	Version of HTML Purifier the directive was introduced, e.g.
	$deprecatedUse
	ID of directive that supercedes this old directive.
	$deprecatedVersion
	Version of HTML Purifier this directive was deprecated.
	$external = array()
	List of external projects this directive depends on, e.g.

Detailed Description

Interchange component class describing configuration directives.

Definition at line 6 of file Directive.php.

Field Documentation

HTMLPurifier_ConfigSchema_Interchange_Directive::$aliases = array()

List of aliases for the directive.

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

Definition at line 52 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$allowed

Lookup table of allowed scalar values.

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

Definition at line 45 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$default

Default value, e.g.

3 or 'DefaultVal'. mixed

Definition at line 25 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$deprecatedUse

ID of directive that supercedes this old directive.

Null if not deprecated. HTMLPurifier_ConfigSchema_Interchange_Id

Definition at line 73 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$deprecatedVersion

Version of HTML Purifier this directive was deprecated.

Null if not deprecated. string

Definition at line 80 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$description

HTML description.

string

Definition at line 31 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$external = array()

List of external projects this directive depends on, e.g.

array('CSSTidy'). array

Definition at line 86 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$id

ID of directive.

HTMLPurifier_ConfigSchema_Interchange_Id

Definition at line 13 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$type

Type, e.g.

'integer' or 'istring'. string

Definition at line 19 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$typeAllowsNull = false

Whether or not null is allowed as a value.

bool

Definition at line 37 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$valueAliases

Hash of value aliases, e.g.

array('alt' => 'real'). Null if value aliasing is disabled (necessary for non-scalar types). array

Definition at line 59 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$version

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

'1.3.1'. Null if the directive has always existed. string

Definition at line 66 of file Directive.php.

---

The documentation for this class was generated from the following file:

• Services/Html/HtmlPurifier/library/HTMLPurifier/ConfigSchema/Interchange/Directive.php