HTMLPurifier_ConfigSchema_Interchange_Directive Class Reference

Interchange component class describing configuration directives. More...

List of all members.

Public Attributes
	$id
	ID of directive, instance of HTMLPurifier_ConfigSchema_Interchange_Id.
	$type
	String type, e.g.
	$default
	Default value, e.g.
	$description
	HTML description.
	$typeAllowsNull = false
	Boolean whether or not null is allowed as a value.
	$allowed
	Lookup table of allowed scalar values, e.g.
	$aliases = array()
	List of aliases for the directive, e.g.
	$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, is an instance of HTMLPurifier_ConfigSchema_Interchange_Id.
	$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.

---

Member Data Documentation

HTMLPurifier_ConfigSchema_Interchange_Directive::$id

ID of directive, instance of HTMLPurifier_ConfigSchema_Interchange_Id.

Definition at line 12 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$type

String type, e.g.

'integer' or 'istring'.

Definition at line 17 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$default

Default value, e.g.

3 or 'DefaultVal'.

Definition at line 22 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$description

HTML description.

Definition at line 27 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$typeAllowsNull = false

Boolean whether or not null is allowed as a value.

Definition at line 32 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.

Definition at line 38 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$aliases = array()

List of aliases for the directive, e.g.

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

Definition at line 44 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).

Definition at line 50 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.

Definition at line 56 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$deprecatedUse

ID of directive that supercedes this old directive, is an instance of HTMLPurifier_ConfigSchema_Interchange_Id.

Null if not deprecated.

Definition at line 62 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$deprecatedVersion

Version of HTML Purifier this directive was deprecated.

Null if not deprecated.

Definition at line 68 of file Directive.php.

HTMLPurifier_ConfigSchema_Interchange_Directive::$external = array()

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

array('CSSTidy').

Definition at line 73 of file Directive.php.

---

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

• library/HTMLPurifier/ConfigSchema/Interchange/Directive.php

---