Merge in r649-656, prompted by changing two of Encoder's functions to static.

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/branches/strict@657 48356398-32a2-884e-a903-53898d9a118a

library/HTMLPurifier/Config.php

@@ -46,6 +46,7 @@ class HTMLPurifier_Config
     
     /**
      * Convenience constructor that creates a config object based on a mixed var
+     * @static
      * @param mixed $config Variable that defines the state of the config
      *                      object. Can be: a HTMLPurifier_Config() object or
      *                      an array of directives based on loadArray().
@@ -60,6 +61,7 @@ class HTMLPurifier_Config
     
     /**
      * Convenience constructor that creates a default configuration object.
+     * @static
      * @return Default HTMLPurifier_Config object.
      */
     static function createDefault() {
@@ -178,4 +180,4 @@ class HTMLPurifier_Config
     
 }
 
-?>
+?>

library/HTMLPurifier/ConfigSchema.php

@@ -67,6 +67,7 @@ class HTMLPurifier_ConfigSchema {
     
     /**
      * Retrieves an instance of the application-wide configuration definition.
+     * @static
      */
     static function &instance($prototype = null) {
         static $instance;
@@ -81,6 +82,7 @@ class HTMLPurifier_ConfigSchema {
     
     /**
      * Defines a directive for configuration
+     * @static
      * @warning Will fail of directive's namespace is defined
      * @param $namespace Namespace the directive is in
      * @param $name Key of directive
@@ -144,6 +146,7 @@ class HTMLPurifier_ConfigSchema {
     
     /**
      * Defines a namespace for directives to be put into.
+     * @static
      * @param $namespace Namespace's name
      * @param $description Description of the namespace
      */
@@ -169,6 +172,7 @@ class HTMLPurifier_ConfigSchema {
      * 
      * Directive value aliases are convenient for developers because it lets
      * them set a directive to several values and get the same result.
+     * @static
      * @param $namespace Directive's namespace
      * @param $name Name of Directive
      * @param $alias Name of aliased value
@@ -200,6 +204,7 @@ class HTMLPurifier_ConfigSchema {
     
     /**
      * Defines a set of allowed values for a directive.
+     * @static
      * @param $namespace Namespace of directive
      * @param $name Name of directive
      * @param $allowed_values Arraylist of allowed values
@@ -380,4 +385,4 @@ class HTMLPurifier_ConfigEntity_Directive extends HTMLPurifier_ConfigEntity
     
 }
 
-?>
+?>

library/HTMLPurifier/Encoder.php

@@ -38,16 +38,25 @@ HTMLPurifier_ConfigSchema::define(
 
 /**
  * A UTF-8 specific character encoder that handles cleaning and transforming.
+ * @note All functions in this class should be static.
  */
 class HTMLPurifier_Encoder
 {
     
+    /**
+     * Constructor throws fatal error if you attempt to instantiate class
+     */
+    function HTMLPurifier_Encoder() {
+        trigger_error('Cannot instantiate encoder, call methods statically', E_USER_ERROR);
+    }
+    
     /**
      * Cleans a UTF-8 string for well-formedness and SGML validity
      * 
      * It will parse according to UTF-8 and return a valid UTF8 string, with
      * non-SGML codepoints excluded.
      * 
+     * @static
      * @note Just for reference, the non-SGML code points are 0 to 31 and
      *       127 to 159, inclusive.  However, we allow code points 9, 10
      *       and 13, which are the tab, line feed and carriage return
@@ -225,6 +234,7 @@ class HTMLPurifier_Encoder
     
     /**
      * Translates a Unicode codepoint into its corresponding UTF-8 character.
+     * @static
      * @note Based on Feyd's function at
      *       <http://forums.devnetwork.net/viewtopic.php?p=191404#191404>,
      *       which is in public domain.
@@ -288,8 +298,9 @@ class HTMLPurifier_Encoder
     
     /**
      * Converts a string to UTF-8 based on configuration.
+     * @static
      */
-    function convertToUTF8($str, $config, &$context) {
+    static function convertToUTF8($str, $config, &$context) {
         static $iconv = null;
         if ($iconv === null) $iconv = function_exists('iconv');
         $encoding = $config->get('Core', 'Encoding');
@@ -303,10 +314,11 @@ class HTMLPurifier_Encoder
     
     /**
      * Converts a string from UTF-8 based on configuration.
+     * @static
      * @note Currently, this is a lossy conversion, with unexpressable
      *       characters being omitted.
      */
-    function convertFromUTF8($str, $config, &$context) {
+    static function convertFromUTF8($str, $config, &$context) {
         static $iconv = null;
         if ($iconv === null) $iconv = function_exists('iconv');
         $encoding = $config->get('Core', 'Encoding');

library/HTMLPurifier/EntityLookup.php

@@ -26,6 +26,7 @@ class HTMLPurifier_EntityLookup {
     
     /**
      * Retrieves sole instance of the object.
+     * @static
      * @param Optional prototype of custom lookup table to overload with.
      */
     static function instance($prototype = false) {

library/HTMLPurifier/HTMLDefinition.php

@@ -653,4 +653,4 @@ class HTMLPurifier_ElementDef
     
 }
 
-?>
+?>

library/HTMLPurifier/Lexer.php

@@ -56,7 +56,6 @@ class HTMLPurifier_Lexer
 {
     
     function HTMLPurifier_Lexer() {
-        $this->_encoder = new HTMLPurifier_Encoder();
         $this->_entity_parser = new HTMLPurifier_EntityParser();
     }
     
@@ -114,8 +113,6 @@ class HTMLPurifier_Lexer
         return $string;
     }
     
-    var $_encoder;
-    
     /**
      * Lexes an HTML string into tokens.
      * 
@@ -138,6 +135,8 @@ class HTMLPurifier_Lexer
      * default with your own implementation.  A copy/reference of the prototype
      * lexer will now be returned when you request a new lexer.
      * 
+     * @static
+     * 
      * @note
      * Though it is possible to call this factory method from subclasses,
      * such usage is not recommended.
@@ -166,6 +165,7 @@ class HTMLPurifier_Lexer
     /**
      * Translates CDATA sections into regular sections (through escaping).
      * 
+     * @static
      * @protected
      * @param $string HTML string to process.
      * @returns HTML with CDATA sections escaped.
@@ -181,6 +181,7 @@ class HTMLPurifier_Lexer
     /**
      * Callback function for escapeCDATA() that does the work.
      * 
+     * @static
      * @warning Though this is public in order to let the callback happen,
      *          calling it directly is not recommended.
      * @params $matches PCRE matches array, with index 0 the entire match
@@ -212,7 +213,7 @@ class HTMLPurifier_Lexer
         // clean into wellformed UTF-8 string for an SGML context: this has
         // to be done after entity expansion because the entities sometimes
         // represent non-SGML characters (horror, horror!)
-        $html = $this->_encoder->cleanUTF8($html);
+        $html = HTMLPurifier_Encoder::cleanUTF8($html);
         
         return $html;
     }

library/HTMLPurifier/Lexer/PEARSax3.php

@@ -37,7 +37,7 @@ class HTMLPurifier_Lexer_PEARSax3 extends HTMLPurifier_Lexer
         
         $string = $this->normalize($string, $config, $context);
         
-        $parser= new XML_HTMLSax3();
+        $parser = new XML_HTMLSax3();
         $parser->set_object($this);
         $parser->set_element_handler('openHandler','closeHandler');
         $parser->set_data_handler('dataHandler');

library/HTMLPurifier/URISchemeRegistry.php

@@ -32,6 +32,7 @@ class HTMLPurifier_URISchemeRegistry
     
     /**
      * Retrieve sole instance of the registry.
+     * @static
      * @param $prototype Optional prototype to overload sole instance with,
      *                   or bool true to reset to default registry.
      * @note Pass a registry object $prototype with a compatible interface and