$version
$version
HTML Purifier's version
Configuration object that triggers customizable behavior.
create(mixed $config, \HTMLPurifier_ConfigSchema $schema = null) : \HTMLPurifier_Config
Convenience constructor that creates a config object based on a mixed var
| mixed | $config | Variable that defines the state of the config object. Can be: a HTMLPurifier_Config() object, an array of directives based on loadArray(), or a string filename of an ini file. |
| \HTMLPurifier_ConfigSchema | $schema | Schema object |
Configured object
getHTMLDefinition(bool $raw = false, bool $optimized = false) : \HTMLPurifier_HTMLDefinition|null
Retrieves object reference to the HTML definition.
| bool | $raw | Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work. |
| bool | $optimized | If true, this method may return null, to indicate that a cached version of the modified definition object is available and no further edits are necessary. Consider using maybeGetRawHTMLDefinition, which is more explicitly named, instead. |
getCSSDefinition(bool $raw = false, bool $optimized = false) : \HTMLPurifier_CSSDefinition|null
Retrieves object reference to the CSS definition
| bool | $raw | Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work. |
| bool | $optimized | If true, this method may return null, to indicate that a cached version of the modified definition object is available and no further edits are necessary. Consider using maybeGetRawCSSDefinition, which is more explicitly named, instead. |
getURIDefinition(bool $raw = false, bool $optimized = false) : \HTMLPurifier_URIDefinition|null
Retrieves object reference to the URI definition
| bool | $raw | Return a copy that has not been setup yet. Must be called before it's been setup, otherwise won't work. |
| bool | $optimized | If true, this method may return null, to indicate that a cached version of the modified definition object is available and no further edits are necessary. Consider using maybeGetRawURIDefinition, which is more explicitly named, instead. |
getDefinition(string $type, bool $raw = false, bool $optimized = false) : \HTMLPurifier_Definition|null
Retrieves a definition
| string | $type | Type of definition: HTML, CSS, etc |
| bool | $raw | Whether or not definition should be returned raw |
| bool | $optimized | Only has an effect when $raw is true. Whether or not to return null if the result is already present in the cache. This is off by default for backwards compatibility reasons, but you need to do things this way in order to ensure that caching is done properly. Check out enduser-customize.html for more details. We probably won't ever change this default, as much as the maybe semantics is the "right thing to do." |
getAllowedDirectivesForForm(array $allowed, \HTMLPurifier_ConfigSchema $schema = null) : array
Returns a list of array(namespace, directive) for all directives that are allowed in a web-form context as per an allowed namespaces/directives list.
| array | $allowed | List of allowed namespaces/directives |
| \HTMLPurifier_ConfigSchema | $schema | Schema to use, if not global copy |
loadArrayFromForm(array $array, string|bool $index = false, array|bool $allowed = true, bool $mq_fix = true, \HTMLPurifier_ConfigSchema $schema = null) : mixed
Loads configuration values from $_GET/$_POST that were posted via ConfigForm
| array | $array | $_GET or $_POST array to import |
| string|bool | $index | Index/name that the config variables are in |
| array|bool | $allowed | List of allowed namespaces/directives |
| bool | $mq_fix | Boolean whether or not to enable magic quotes fix |
| \HTMLPurifier_ConfigSchema | $schema | Schema to use, if not global copy |
mergeArrayFromForm(array $array, string|bool $index = false, array|bool $allowed = true, bool $mq_fix = true) : mixed
Merges in configuration values from $_GET/$_POST to object. NOT STATIC.
| array | $array | $_GET or $_POST array to import |
| string|bool | $index | Index/name that the config variables are in |
| array|bool | $allowed | List of allowed namespaces/directives |
| bool | $mq_fix | Boolean whether or not to enable magic quotes fix |
prepareArrayFromForm(array $array, string|bool $index = false, array|bool $allowed = true, bool $mq_fix = true, \HTMLPurifier_ConfigSchema $schema = null) : array
Prepares an array from a form into something usable for the more strict parts of HTMLPurifier_Config
| array | $array | $_GET or $_POST array to import |
| string|bool | $index | Index/name that the config variables are in |
| array|bool | $allowed | List of allowed namespaces/directives |
| bool | $mq_fix | Boolean whether or not to enable magic quotes fix |
| \HTMLPurifier_ConfigSchema | $schema | Schema to use, if not global copy |
initDefinition(string $type) : \HTMLPurifier_CSSDefinition|\HTMLPurifier_HTMLDefinition|\HTMLPurifier_URIDefinition
Initialise definition
| string | $type | What type of definition to create |