Download the PHP package nedarta/yii2-clean-html-behavior without Composer
On this page you can find all versions of the php package nedarta/yii2-clean-html-behavior. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package yii2-clean-html-behavior
Yii2 Clean HTML Behavior
A Yii2 behavior that sanitizes and normalizes HTML attributes on ActiveRecord models. It runs automatically on
beforeValidate, beforeInsert, and beforeUpdate to strip unsafe markup, fix spacing and punctuation, and optionally
reformat line breaks while preserving emoji when required.
Features
- Cleans HTML using Yii's
HtmlPurifierwith sensible defaults (nofollow links,_blanktargets, no inline styles). - Removes unwanted attributes (
class,style,id,dir,role,tabindex,contenteditable,spellcheck,attributionsrc,data-*,aria-*). - Normalizes punctuation spacing and collapses double spaces.
- Converts
<div>containers to paragraphs and unwraps<span>tags. - Optional emoji preservation via placeholder storage and restoration.
- Configurable handling for line breaks: keep
<br>, convert to paragraphs or lists, or strip entirely.
Installation
Install the package via Composer:
Basic Usage
Attach the behavior to an ActiveRecord model and configure which attributes should be sanitized:
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
attributes |
array |
[] (required) |
List of ActiveRecord attributes to clean. Throws InvalidConfigException when empty. |
htmlPurifierConfig |
array |
See below | Configuration passed to HtmlPurifier::process. Defaults allow basic formatting tags and disable auto-paragraphing while stripping inline styles and enforcing rel="nofollow"/target="_blank". |
preserveLineBreaks |
bool |
true |
When false, replaces <br> tags with spaces or newlines before purification. |
convertLineBreaks |
string|false |
false |
After purification, convert line breaks into paragraphs ('p'), unordered lists ('ul'), or remove them (false). Only applied when preserveLineBreaks is false. |
keepEmoji |
bool |
false |
Store emoji as placeholders before processing and restore them afterwards. |
Default HtmlPurifier configuration
Override only the keys you need:
Handling line breaks
You can control how <br> tags and raw newlines are treated:
- Preserve (default): leaves
<br>tags untouched. - Strip: set
preserveLineBreakstofalseandconvertLineBreakstofalseto collapse line breaks into spaces. - Paragraphs: set
convertLineBreaksto'p'to wrap newline-separated text into<p>tags when no block markup is already present. - List: set
convertLineBreaksto'ul'to turn newline-separated lines into a bullet list when no block markup is present.
Emoji support
Set keepEmoji to true to temporarily replace emoji with placeholders during purification and restore them afterward,
ensuring they are not stripped by the purifier.
Events
The behavior cleans configured attributes automatically during:
ActiveRecord::EVENT_BEFORE_VALIDATEActiveRecord::EVENT_BEFORE_INSERTActiveRecord::EVENT_BEFORE_UPDATE
License
This project is licensed under the MIT License. See LICENSE for details.
