Merge branch 'master' of git.gnu.io:gnu/gnu-social into mmn_fixes

[quix0rs-gnu-social.git] / extlib / HTMLPurifier / HTMLPurifier / Definition.php

diff --git a/extlib/HTMLPurifier/HTMLPurifier/Definition.php b/extlib/HTMLPurifier/HTMLPurifier/Definition.php
index a7408c97498eabfa586ca762f82ae102ae88a7c7..bc6d43364776493975caa4c3f7958321391c8650 100644 (file)
--- a/extlib/HTMLPurifier/HTMLPurifier/Definition.php
+++ b/extlib/HTMLPurifier/HTMLPurifier/Definition.php
@@ -9,31 +9,47 @@ abstract class HTMLPurifier_Definition
 
     /**
      * Has setup() been called yet?
+     * @type bool
      */
     public $setup = false;
 
+    /**
+     * If true, write out the final definition object to the cache after
+     * setup.  This will be true only if all invocations to get a raw
+     * definition object are also optimized.  This does not cause file
+     * system thrashing because on subsequent calls the cached object
+     * is used and any writes to the raw definition object are short
+     * circuited.  See enduser-customize.html for the high-level
+     * picture.
+     * @type bool
+     */
+    public $optimized = null;
+
     /**
      * What type of definition is it?
+     * @type string
      */
     public $type;
 
     /**
      * Sets up the definition object into the final form, something
      * not done by the constructor
-     * @param $config HTMLPurifier_Config instance
+     * @param HTMLPurifier_Config $config
      */
     abstract protected function doSetup($config);
 
     /**
      * Setup function that aborts if already setup
-     * @param $config HTMLPurifier_Config instance
+     * @param HTMLPurifier_Config $config
      */
-    public function setup($config) {
-        if ($this->setup) return;
+    public function setup($config)
+    {
+        if ($this->setup) {
+            return;
+        }
         $this->setup = true;
         $this->doSetup($config);
     }
-
 }
 
 // vim: et sw=4 sts=4