Download the PHP package atwx/silverstripe-htmlfield-cleaner without Composer
On this page you can find all versions of the php package atwx/silverstripe-htmlfield-cleaner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package silverstripe-htmlfield-cleaner
Silverstripe HTML Field Cleaner
Cleans the HTML fields (HTMLText, HTMLVarchar, …) of DataObjects before they are written.
Unwanted attributes such as inline styles and data-* are removed, <span> tags get unwrapped,
and TinyMCE's underline spans are turned into <u>. All rules are configured in YAML.
Built on mehr-it/html-cleaner.
Installation
The extension is applied automatically to:
SilverStripe\CMS\Model\SiteTree(ifsilverstripe/cmsis installed)SilverStripe\SiteConfig\SiteConfig(ifsilverstripe/siteconfigis installed)DNADesign\Elemental\Models\BaseElement(ifdnadesign/silverstripe-elementalis installed)
Add it to other DataObjects yourself:
Default behaviour
| Setting | Default |
|---|---|
attribute_whitelist |
href, src, alt, title, target, rel, class |
unwrap |
span |
preprocessors |
underline: <span style="text-decoration: underline"> → <u> |
field_type_prefixes |
HTML (all db types starting with HTML) |
Global configuration
All list settings are maps (item: true|false). This lets you switch off a single default
entry, which plain YAML lists can't do, because Silverstripe merges lists by appending.
Plain lists (- item) are still accepted for adding entries.
Per class configuration
Configured on the DataObject class. It inherits to subclasses, like any other Silverstripe config.
Remove the default extensions
The extensions are registered with the name htmlfieldcleaner, so they can be removed again:
Custom preprocessors
Preprocessors work on the parsed DOM before the cleaning rules are applied. Use them to convert markup that would otherwise be lost, as the underline preprocessor does.
Using the cleaner directly
Running the tests
All versions of silverstripe-htmlfield-cleaner with dependencies
ext-dom Version *
silverstripe/framework Version ^6
mehr-it/html-cleaner Version ^1.1