Continued:
[core.git] / framework / main / classes / parser / xml / class_XmlParser.php
index 9ebf852cf4107560556d3fcd244235ec7092f56e..7b09884e3d00fb75d1e33bac5185a97e70c35954 100644 (file)
@@ -3,16 +3,21 @@
 namespace Org\Mxchange\CoreFramework\Parser\Xml;
 
 // Import framework stuff
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
+use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
 use Org\Mxchange\CoreFramework\Parser\BaseParser;
 use Org\Mxchange\CoreFramework\Parser\Parseable;
 use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
 
+// Import SPL stuff
+use \InvalidArgumentException;
+
 /**
  * A Xml Parser class
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -30,17 +35,12 @@ use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class XmlParser extends BaseParser implements Parseable {
-       // Exception constants
-       const EXCEPTION_XML_PARSER_ERROR             = 0x1e0;
-       const EXCEPTION_XML_NODE_UNKNOWN             = 0x1e1;
-       const EXCEPTION_XML_NODE_MISMATCH            = 0x1e2;
-
        /**
         * Protected constructor
         *
         * @return      void
         */
-       protected function __construct () {
+       private function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }
@@ -69,14 +69,12 @@ class XmlParser extends BaseParser implements Parseable {
         * @return      void
         * @throws      XmlParserException      If an XML error was found
         */
-       public function parseXmlContent ($content) {
+       public function parseXmlContent (string $content) {
                // Convert all to UTF8
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-PARSER: content()=%d - CALLED!', strlen($content)));
                if (empty($content)) {
-                       // No empty content!
-                       self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Empty content! Backtrace: <pre>');
-                       debug_print_backtrace();
-                       self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('</pre>');
-                       exit();
+                       // No empty content
+                       throw new InvalidArgumentException('content is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
                } elseif (function_exists('recode')) {
                        // Recode found, so use it
                        $content = recode('html..utf8', $content);
@@ -85,37 +83,40 @@ class XmlParser extends BaseParser implements Parseable {
                        $content = mb_convert_encoding($content, 'UTF-8', 'auto');
                } else {
                        // @TODO We need to find a fallback solution here
-                       $this->partialStub('Cannot find recode/mbstring extension!');
-               } // END - if
+                       DebugMiddleware::getSelfInstance()->partialStub('Cannot find recode/mbstring extension!');
+               }
 
                // Get an XML parser
                $xmlParser = xml_parser_create();
 
                // Force case-folding to on
-               xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, true);
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-PARSER: Created xmlParser=%s ...', $xmlParser));
+               xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, TRUE);
 
                // Set UTF-8
                xml_parser_set_option($xmlParser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
 
-               // Get instance (we need this :( )
-               $templateInstance = $this->getTemplateInstance();
-
                // Set object
-               xml_set_object($xmlParser, $templateInstance);
+               xml_set_object($xmlParser, $this->getTemplateInstance());
 
                // Set handler call-backs
                xml_set_element_handler($xmlParser, 'startElement', 'finishElement');
                xml_set_character_data_handler($xmlParser, 'characterHandler');
 
                // Now parse the XML tree
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-PARSER: Invoking xml_parse(%s, content()=%d) ...', $xmlParser, strlen($content)));
                if (!xml_parse($xmlParser, $content)) {
-                       // Error found in XML!
+                       // Error found in XML
                        //* DEBUG: */ exit(__METHOD__ . ':<pre>'.htmlentities($content).'</pre>');
-                       throw new XmlParserException(array($this, $xmlParser), self::EXCEPTION_XML_PARSER_ERROR);
-               } // END - if
+                       throw new XmlParserException([$this, $xmlParser], Parseable::EXCEPTION_XML_PARSER_ERROR);
+               }
 
                // Free the parser
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-PARSER: Freeing xmlParser=%s ...', $xmlParser));
                xml_parser_free($xmlParser);
+
+               // Trace message
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('XML-PARSER: EXIT!');
        }
 
 }