Browse Source

Documentation tweaks

master
J. King 1 year ago
parent
commit
737bed1dfc
  1. 6
      lib/AbstractSanitizer.php

6
lib/AbstractSanitizer.php

@ -21,11 +21,11 @@ abstract class AbstractSanitizer {
/** @var array $config The parsed configuration, as used for processing */ /** @var array $config The parsed configuration, as used for processing */
protected $config; protected $config;
/** Initializes a sanitizer with the provided configuration, or the default configuration /** Initializes a sanitizer with the provided configuration, or the default configuration if no configuration is provided
* *
* The configuration array may contain any of the following keys: * The configuration array may contain any of the following keys:
* *
* - `allowElements`: an indexed array of elements to allow. Elements not in this list will be blocked as if they were included in the `blockElements` list * - `allowElements`: an indexed array of elements to retain in the tree. Elements not in this list will be blocked as if they were included in the `blockElements` list
* - `blockElements`: an indexed array of elements to remove from the tree while retaining their children * - `blockElements`: an indexed array of elements to remove from the tree while retaining their children
* - `dropElements`: an indexed array of elements to remove from the tree along with their children * - `dropElements`: an indexed array of elements to remove from the tree along with their children
* - `allowAttributes`: an indexed array of attributes to allow on certain elements. Attributes not in this list will be dropped * - `allowAttributes`: an indexed array of attributes to allow on certain elements. Attributes not in this list will be dropped
@ -45,7 +45,7 @@ abstract class AbstractSanitizer {
* *
* - `name`: The localName of the attribute * - `name`: The localName of the attribute
* - `namespace`: The namespaceURI of the attribute. If omitted the null namespace is assumed * - `namespace`: The namespaceURI of the attribute. If omitted the null namespace is assumed
* - `elements`: An indexed array of elements on which to allow the attribute, in the same format as other element lists. The string `"*"` may also be supplied instead of an array to mean all elements * - `elements`: An indexed array of elements on which to allow the attribute, in the same format as other element lists. The string `"*"` may be supplied instead of an array to mean all elements
* *
* @param array $config A configuration to use instead of the default one * @param array $config A configuration to use instead of the default one
*/ */

Loading…
Cancel
Save