Directive.php 1.9 KB

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