Interchange component class describing configuration directives.
| Properties | |||
|---|---|---|---|
public
|
|
$id
ID of directive.
ID of directive. |
# |
public
|
|
$type
Type, e.g. 'integer' or 'istring'.
Type, e.g. 'integer' or 'istring'. |
# |
public
|
|
$default
Default value, e.g. 3 or 'DefaultVal'.
Default value, e.g. 3 or 'DefaultVal'. |
# |
public
|
|
$description
HTML description.
HTML description. |
# |
public
|
|
$typeAllowsNull = false
Whether or not null is allowed as a value.
Whether or not null is allowed as a value. |
# |
public
|
|
$allowed
Lookup table of allowed scalar values.
e.g. array('allowed' => true).
Null if all values are allowed.
Lookup table of allowed scalar values. e.g. array('allowed' => true). Null if all values are allowed. |
# |
public
|
|
$aliases = []
List of aliases for the directive.
e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))).
List of aliases for the directive. e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))). |
# |
public
|
|
$valueAliases
Hash of value aliases, e.g. array('alt' => 'real'). Null if value
aliasing is disabled (necessary for non-scalar types).
Hash of value aliases, e.g. array('alt' => 'real'). Null if value aliasing is disabled (necessary for non-scalar types). |
# |
public
|
|
$version
Version of HTML Purifier the directive was introduced, e.g. '1.3.1'.
Null if the directive has always existed.
Version of HTML Purifier the directive was introduced, e.g. '1.3.1'. Null if the directive has always existed. |
# |
public
|
|
$deprecatedUse
ID of directive that supercedes this old directive.
Null if not deprecated.
ID of directive that supercedes this old directive. Null if not deprecated. |
# |
public
|
|
$deprecatedVersion
Version of HTML Purifier this directive was deprecated. Null if not
deprecated.
Version of HTML Purifier this directive was deprecated. Null if not deprecated. |
# |
public
|
|
$external = []
List of external projects this directive depends on, e.g. array('CSSTidy').
List of external projects this directive depends on, e.g. array('CSSTidy'). |
# |