Merge branch 'master' into 2.0

Author: Florian Krämer

README.md

@@ -9,7 +9,7 @@ This is a CakePHP wrapper for the HTML Purifier lib. http://htmlpurifier.org/
 
 HTML Purifier is a standards-compliant HTML filter library written in PHP. HTML Purifier will not only remove all malicious code (better known as XSS) with a thoroughly audited, secure yet permissive whitelist, it will also make sure your documents are standards compliant, something only achievable with a comprehensive knowledge of W3C's specifications.
 
-The plugin includes a Helper and Behavior to clean your markup wherever you like, in the view or in Model::beforeSave.
+The plugin includes a Helper, Behavior and a Shell to clean your markup wherever you like, in the view or in Model::beforeMarshall().
 
 ---
 

composer.json

@@ -13,7 +13,7 @@
 	],
 	"minimum-stability": "stable",
 	"require": {
-		"cakephp/cakephp": "~3.0",
+		"cakephp/cakephp": "3.*",
 		"ezyang/htmlpurifier": "*"
 	},
 	"autoload": {

docs/Documentation/Configuration.md

@@ -0,0 +1,63 @@
+# Configuration
+
+**Important:** Before you start declaring a configuration you should [lookup how HTML Purifier can be configured](http://htmlpurifier.org/docs).
+
+In `config/bootstrap.php` you can either set the purifier config as an array or pass a native config object.
+
+The array style would look like this:
+
+```php
+// Don't forget to add the `use` statement
+use Burzum\HtmlPurifier\Lib\Purifier;
+
+Purifier::config('ConfigName', array(
+        'HTML.AllowedElements' => 'a, em, blockquote, p, strong, pre, code, span,ul,ol,li,img',
+        'HTML.AllowedAttributes' => 'a.href, a.title, img.src, img.alt'
+    )
+);
+```
+
+The plugin will construct a HTML Purifier config from that and instantiate the purifier.
+
+A pure HTML Purifier config might look like this one:
+
+```php
+$config = HTMLPurifier_Config::createDefault();
+$config->set('HTML.AllowedElements', 'a, em, blockquote, p, strong, pre, code, span,ul,ol,li,img');
+$config->set('HTML.AllowedAttributes', 'a.href, a.title, img.src, img.alt');
+$config->set('HTML.AllowedAttributes', "*.style");
+$config->set('CSS.AllowedProperties', 'text-decoration');
+$config->set('HTML.TidyLevel', 'heavy');
+$config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
+```
+
+Simply assign it to a config:
+
+```php
+Purifier::config('ConfigName', $config);
+```
+
+Now that you have a configured instance of HTML Purifier ready you can use it directly and get you an instance of the purifier
+
+```php
+Purifier::config('ConfigName');
+```
+
+or clean some dirty HTML directly by calling
+
+```php
+Purifier::clean($markup, 'ConfigName');
+```
+
+## Caching ###
+
+It is recommended to change the path of the purifier libs cache to your `tmp` folder. For example:
+
+```php
+Purifier::config('ConfigName', array(
+        'Cache.SerializerPath' => ROOT . DS . 'tmp' . DS . 'purifier',
+    )
+);
+```
+
+See this page as well http://htmlpurifier.org/live/configdoc/plain.html#Cache.

docs/Documentation/If-you-use-APC.md

@@ -0,0 +1,15 @@
+# If you use APC ...
+
+...and get this error message
+
+	Fatal error: Cannot override final method HTMLPurifier_VarParser::parse()
+
+you can fix this by adding
+
+```php
+Configure::write('HtmlPurifier.standalone', true);
+```
+
+to your bootstrap.php *before* you load this plugin.
+
+This line will use a compacted one file version of Html Purifier. This is an official and know issue and workaround, see http://htmlpurifier.org/phorum/read.php?3,4099,6680.

docs/Installation.md renamed to docs/Documentation/Installation.md

@@ -1,8 +1,6 @@
-Installation
-============
+# Installation
 
-Using Composer
---------------
+## Using Composer
 
 Installing the plugin via [Composer](https://getcomposer.org/) is very simple, just run this in your project folder:
 

docs/Home.md

@@ -0,0 +1,12 @@
+Home
+====
+
+The **Html Purifier** plugin
+
+Documentation
+-------------
+
+* [Installation](Documentation/Installation.md)
+* [Configuration](Documentation/Configuration.md)
+* [If you use APC](Documentation/If-you-use-APC.md)
+

docs/Usage.md

@@ -102,7 +102,7 @@ public static function clean($markup, $configName = null)
         $_this = Purifier::getInstance();
 
         if (!isset($_this->_configs[$configName])) {
-            throw new \InvalidArgumentException(sprintf('Invalid configuration %s!', $configName));
+            throw new \InvalidArgumentException(sprintf('Invalid HtmlPurifier configuration "%s"!', $configName));
         }
 
         return $_this->getPurifierInstance($configName)->purify($markup);

src/Lib/Purifier.php

@@ -18,9 +18,9 @@ class HtmlPurifierHelper extends Helper {
  *
  * @var array
  */
-	public $_defaultConfig = [
-		'config' => ''
-	];
+    public $_defaultConfig = [
+        'config' => 'default'
+    ];
 
 /**
  * Clean markup
@@ -29,10 +29,11 @@ class HtmlPurifierHelper extends Helper {
  * @param string $config
  * @return string
  */
-	public function clean($markup, $config = null) {
-		if (empty($config) && !empty($this->_config['config'])) {
-			$config = $this->settings['config'];
-		}
-		return Purifier::clean($markup, $config);
-	}
+    public function clean($markup, $config = null)
+    {
+        if (empty($config) && !empty($this->_config['config'])) {
+            $config = $this->config('config');
+        }
+        return Purifier::clean($markup, $config);
+    }
 }