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