Don't suggest 777, only 775.
[htmlpurifier.git] / library / HTMLPurifier / ConfigSchema / Interchange / Directive.php
blob127a39a673e6ccabf2073180cc3f9aede1330061
1 <?php
3 /**
4 * Interchange component class describing configuration directives.
5 */
6 class HTMLPurifier_ConfigSchema_Interchange_Directive
9 /**
10 * ID of directive.
11 * @type HTMLPurifier_ConfigSchema_Interchange_Id
13 public $id;
15 /**
16 * Type, e.g. 'integer' or 'istring'.
17 * @type string
19 public $type;
21 /**
22 * Default value, e.g. 3 or 'DefaultVal'.
23 * @type mixed
25 public $default;
27 /**
28 * HTML description.
29 * @type string
31 public $description;
33 /**
34 * Whether or not null is allowed as a value.
35 * @type bool
37 public $typeAllowsNull = false;
39 /**
40 * Lookup table of allowed scalar values.
41 * e.g. array('allowed' => true).
42 * Null if all values are allowed.
43 * @type array
45 public $allowed;
47 /**
48 * List of aliases for the directive.
49 * e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))).
50 * @type HTMLPurifier_ConfigSchema_Interchange_Id[]
52 public $aliases = array();
54 /**
55 * Hash of value aliases, e.g. array('alt' => 'real'). Null if value
56 * aliasing is disabled (necessary for non-scalar types).
57 * @type array
59 public $valueAliases;
61 /**
62 * Version of HTML Purifier the directive was introduced, e.g. '1.3.1'.
63 * Null if the directive has always existed.
64 * @type string
66 public $version;
68 /**
69 * ID of directive that supercedes this old directive.
70 * Null if not deprecated.
71 * @type HTMLPurifier_ConfigSchema_Interchange_Id
73 public $deprecatedUse;
75 /**
76 * Version of HTML Purifier this directive was deprecated. Null if not
77 * deprecated.
78 * @type string
80 public $deprecatedVersion;
82 /**
83 * List of external projects this directive depends on, e.g. array('CSSTidy').
84 * @type array
86 public $external = array();
89 // vim: et sw=4 sts=4