2010-09-09 03:14:17 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Interchange component class describing configuration directives.
|
|
|
|
*/
|
|
|
|
class HTMLPurifier_ConfigSchema_Interchange_Directive
|
|
|
|
{
|
|
|
|
|
|
|
|
/**
|
2016-02-09 10:06:17 +00:00
|
|
|
* ID of directive.
|
|
|
|
* @type HTMLPurifier_ConfigSchema_Interchange_Id
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $id;
|
|
|
|
|
|
|
|
/**
|
2016-02-09 10:06:17 +00:00
|
|
|
* Type, e.g. 'integer' or 'istring'.
|
|
|
|
* @type string
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $type;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Default value, e.g. 3 or 'DefaultVal'.
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type mixed
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $default;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* HTML description.
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type string
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $description;
|
|
|
|
|
|
|
|
/**
|
2016-02-09 10:06:17 +00:00
|
|
|
* Whether or not null is allowed as a value.
|
|
|
|
* @type bool
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $typeAllowsNull = false;
|
|
|
|
|
|
|
|
/**
|
2016-02-09 10:06:17 +00:00
|
|
|
* Lookup table of allowed scalar values.
|
|
|
|
* e.g. array('allowed' => true).
|
2010-09-09 03:14:17 +00:00
|
|
|
* Null if all values are allowed.
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type array
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $allowed;
|
|
|
|
|
|
|
|
/**
|
2016-02-09 10:06:17 +00:00
|
|
|
* List of aliases for the directive.
|
2010-09-09 03:14:17 +00:00
|
|
|
* e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))).
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type HTMLPurifier_ConfigSchema_Interchange_Id[]
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $aliases = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Hash of value aliases, e.g. array('alt' => 'real'). Null if value
|
|
|
|
* aliasing is disabled (necessary for non-scalar types).
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type array
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $valueAliases;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Version of HTML Purifier the directive was introduced, e.g. '1.3.1'.
|
|
|
|
* Null if the directive has always existed.
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type string
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $version;
|
|
|
|
|
|
|
|
/**
|
2016-02-09 10:06:17 +00:00
|
|
|
* ID of directive that supercedes this old directive.
|
|
|
|
* Null if not deprecated.
|
|
|
|
* @type HTMLPurifier_ConfigSchema_Interchange_Id
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $deprecatedUse;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Version of HTML Purifier this directive was deprecated. Null if not
|
|
|
|
* deprecated.
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type string
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $deprecatedVersion;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of external projects this directive depends on, e.g. array('CSSTidy').
|
2016-02-09 10:06:17 +00:00
|
|
|
* @type array
|
2010-09-09 03:14:17 +00:00
|
|
|
*/
|
|
|
|
public $external = array();
|
|
|
|
}
|
|
|
|
|
|
|
|
// vim: et sw=4 sts=4
|