happydemon / purifier
Packages HTML purifier
Installs: 21
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 27
Type:kohana-module
Requires
- php: >5.3.2
- composer/installers: *
- ezyang/htmlpurifier: 4.6.*
This package is auto-updated.
Last update: 2024-08-12 20:59:42 UTC
README
Overloads Security::xss_clean to provide secure XSS filtering using HTML Purifier.
Installing Purifier
Using Git
If your application is in a Git repository, you can simply add this repository as a submodule:
git submodule add git://github.com/shadowhand/purifier.git modules/purifier
git submodule update --init --recursive
If you want to use a specific version, you can check out the tag of that version:
cd modules/purifier
git checkout v0.1.0
cd -
git add modules/purifier
Always remember to commit changes you make to submodules!
git commit -m 'Added Purifier module'
To install HTML Purifier, you will need to go into the purifier module directory and download it:
cd modules/purifier
git submodule update --init --recursive
HTML Purifier is enabled as submodule of the Purifier module. Submodules of submodules are only automatically initialized if you use the --recursive flag
FTP or Plain Files
For an untracked repository, you can download the repository and install it to MODPATH/purifier
. To download a specific version, select the tag on Github before clicking the download link.
You will also need to download HTML Purifier and install the entire "htmlpurifier" directory to MODPATH/purifier/vendor/htmlpurifier
.
After Installation
After HTML Purifier is installed, you will need to make the library/HTMLPurifier/DefinitionCache/Serializer
in MODPATH/purifier/vendor/htmlpurifier
writable by the web server.
Using Purifier
To use Purifier, just call Security::xss_clean as you normally would. HTML Purifier will be used instead of the default "Bitflux" filter.
Advanced Usage
If you want to access HTMLPurifier directly:
$html = Security::htmlpurifier();
You can configure the HTMLPurifier settings by creating APPPATH/config/purifier.php
:
return array(
'settings' => array(
... => ...
),
);