]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - extlib/HTMLPurifier/HTMLPurifier/EntityLookup.php
Merge branch 'master' of git.gnu.io:gnu/gnu-social into mmn_fixes
[quix0rs-gnu-social.git] / extlib / HTMLPurifier / HTMLPurifier / EntityLookup.php
index b4dfce94c3852a21162e588e69b87e4062af23a8..f12ff13a35a5f6e05c2b3e02688e0dad0df6005e 100644 (file)
@@ -3,20 +3,23 @@
 /**
  * Object that provides entity lookup table from entity name to character
  */
-class HTMLPurifier_EntityLookup {
-
+class HTMLPurifier_EntityLookup
+{
     /**
      * Assoc array of entity name to character represented.
+     * @type array
      */
     public $table;
 
     /**
      * Sets up the entity lookup table from the serialized file contents.
+     * @param bool $file
      * @note The serialized contents are versioned, but were generated
      *       using the maintenance script generate_entity_file.php
      * @warning This is not in constructor to help enforce the Singleton
      */
-    public function setup($file = false) {
+    public function setup($file = false)
+    {
         if (!$file) {
             $file = HTMLPURIFIER_PREFIX . '/HTMLPurifier/EntityLookup/entities.ser';
         }
@@ -25,9 +28,11 @@ class HTMLPurifier_EntityLookup {
 
     /**
      * Retrieves sole instance of the object.
-     * @param Optional prototype of custom lookup table to overload with.
+     * @param bool|HTMLPurifier_EntityLookup $prototype Optional prototype of custom lookup table to overload with.
+     * @return HTMLPurifier_EntityLookup
      */
-    public static function instance($prototype = false) {
+    public static function instance($prototype = false)
+    {
         // no references, since PHP doesn't copy unless modified
         static $instance = null;
         if ($prototype) {
@@ -38,7 +43,6 @@ class HTMLPurifier_EntityLookup {
         }
         return $instance;
     }
-
 }
 
 // vim: et sw=4 sts=4