1<?php
2
3/**
4 * Interchange component class describing configuration directives.
5 */
6class HTMLPurifier_ConfigSchema_Interchange_Directive
7{
8
9    /**
10     * ID of directive, instance of HTMLPurifier_ConfigSchema_Interchange_Id.
11     */
12    public $id;
13
14    /**
15     * String type, e.g. 'integer' or 'istring'.
16     */
17    public $type;
18
19    /**
20     * Default value, e.g. 3 or 'DefaultVal'.
21     */
22    public $default;
23
24    /**
25     * HTML description.
26     */
27    public $description;
28
29    /**
30     * Boolean whether or not null is allowed as a value.
31     */
32    public $typeAllowsNull = false;
33
34    /**
35     * Lookup table of allowed scalar values, e.g. array('allowed' => true).
36     * Null if all values are allowed.
37     */
38    public $allowed;
39
40    /**
41     * List of aliases for the directive,
42     * e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))).
43     */
44    public $aliases = array();
45
46    /**
47     * Hash of value aliases, e.g. array('alt' => 'real'). Null if value
48     * aliasing is disabled (necessary for non-scalar types).
49     */
50    public $valueAliases;
51
52    /**
53     * Version of HTML Purifier the directive was introduced, e.g. '1.3.1'.
54     * Null if the directive has always existed.
55     */
56    public $version;
57
58    /**
59     * ID of directive that supercedes this old directive, is an instance
60     * of HTMLPurifier_ConfigSchema_Interchange_Id. Null if not deprecated.
61     */
62    public $deprecatedUse;
63
64    /**
65     * Version of HTML Purifier this directive was deprecated. Null if not
66     * deprecated.
67     */
68    public $deprecatedVersion;
69
70    /**
71     * List of external projects this directive depends on, e.g. array('CSSTidy').
72     */
73    public $external = array();
74
75}
76
77// vim: et sw=4 sts=4
78