]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - extlib/HTMLPurifier/HTMLPurifier/EntityParser.php
Merge branch 'master' of git.gnu.io:gnu/gnu-social into mmn_fixes
[quix0rs-gnu-social.git] / extlib / HTMLPurifier / HTMLPurifier / EntityParser.php
index 8c384472dc6c12ee507c396f12bdf1722c00646a..61529dcd9d9669103502e4e3527ab57f74a1213b 100644 (file)
@@ -12,19 +12,21 @@ class HTMLPurifier_EntityParser
 
     /**
      * Reference to entity lookup table.
+     * @type HTMLPurifier_EntityLookup
      */
     protected $_entity_lookup;
 
     /**
      * Callback regex string for parsing entities.
+     * @type string
      */
     protected $_substituteEntitiesRegex =
-'/&(?:[#]x([a-fA-F0-9]+)|[#]0*(\d+)|([A-Za-z_:][A-Za-z0-9.\-_:]*));?/';
-//     1. hex             2. dec      3. string (XML style)
-
+        '/&(?:[#]x([a-fA-F0-9]+)|[#]0*(\d+)|([A-Za-z_:][A-Za-z0-9.\-_:]*));?/';
+        //     1. hex             2. dec      3. string (XML style)
 
     /**
      * Decimal to parsed string conversion table for special entities.
+     * @type array
      */
     protected $_special_dec2str =
             array(
@@ -37,6 +39,7 @@ class HTMLPurifier_EntityParser
 
     /**
      * Stripped entity names to decimal conversion table for special entities.
+     * @type array
      */
     protected $_special_ent2dec =
             array(
@@ -51,41 +54,45 @@ class HTMLPurifier_EntityParser
      * running this whenever you have parsed character is t3h 5uck, we run
      * it before everything else.
      *
-     * @param $string String to have non-special entities parsed.
-     * @returns Parsed string.
+     * @param string $string String to have non-special entities parsed.
+     * @return string Parsed string.
      */
-    public function substituteNonSpecialEntities($string) {
+    public function substituteNonSpecialEntities($string)
+    {
         // it will try to detect missing semicolons, but don't rely on it
         return preg_replace_callback(
             $this->_substituteEntitiesRegex,
             array($this, 'nonSpecialEntityCallback'),
             $string
-            );
+        );
     }
 
     /**
      * Callback function for substituteNonSpecialEntities() that does the work.
      *
-     * @param $matches  PCRE matches array, with 0 the entire match, and
+     * @param array $matches  PCRE matches array, with 0 the entire match, and
      *                  either index 1, 2 or 3 set with a hex value, dec value,
      *                  or string (respectively).
-     * @returns Replacement string.
+     * @return string Replacement string.
      */
 
-    protected function nonSpecialEntityCallback($matches) {
+    protected function nonSpecialEntityCallback($matches)
+    {
         // replaces all but big five
         $entity = $matches[0];
         $is_num = (@$matches[0][1] === '#');
         if ($is_num) {
             $is_hex = (@$entity[2] === 'x');
             $code = $is_hex ? hexdec($matches[1]) : (int) $matches[2];
-
             // abort for special characters
-            if (isset($this->_special_dec2str[$code]))  return $entity;
-
+            if (isset($this->_special_dec2str[$code])) {
+                return $entity;
+            }
             return HTMLPurifier_Encoder::unichr($code);
         } else {
-            if (isset($this->_special_ent2dec[$matches[3]])) return $entity;
+            if (isset($this->_special_ent2dec[$matches[3]])) {
+                return $entity;
+            }
             if (!$this->_entity_lookup) {
                 $this->_entity_lookup = HTMLPurifier_EntityLookup::instance();
             }
@@ -103,14 +110,16 @@ class HTMLPurifier_EntityParser
      * @notice We try to avoid calling this function because otherwise, it
      * would have to be called a lot (for every parsed section).
      *
-     * @param $string String to have non-special entities parsed.
-     * @returns Parsed string.
+     * @param string $string String to have non-special entities parsed.
+     * @return string Parsed string.
      */
-    public function substituteSpecialEntities($string) {
+    public function substituteSpecialEntities($string)
+    {
         return preg_replace_callback(
             $this->_substituteEntitiesRegex,
             array($this, 'specialEntityCallback'),
-            $string);
+            $string
+        );
     }
 
     /**
@@ -118,12 +127,13 @@ class HTMLPurifier_EntityParser
      *
      * This callback has same syntax as nonSpecialEntityCallback().
      *
-     * @param $matches  PCRE-style matches array, with 0 the entire match, and
+     * @param array $matches  PCRE-style matches array, with 0 the entire match, and
      *                  either index 1, 2 or 3 set with a hex value, dec value,
      *                  or string (respectively).
-     * @returns Replacement string.
+     * @return string Replacement string.
      */
-    protected function specialEntityCallback($matches) {
+    protected function specialEntityCallback($matches)
+    {
         $entity = $matches[0];
         $is_num = (@$matches[0][1] === '#');
         if ($is_num) {
@@ -138,7 +148,6 @@ class HTMLPurifier_EntityParser
                 $entity;
         }
     }
-
 }
 
 // vim: et sw=4 sts=4