framework/main/classes/decorator/xml/compactor/class_XmlCompactorDecorator.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Parser\Xml;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
   7 use Org\Mxchange\CoreFramework\Generic\BaseDecorator;
   8 use Org\Mxchange\CoreFramework\Parser\Parseable;
   9
  10 /**
  11  * A XML compacting decorator class for XML parsers
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class XmlCompactorDecorator extends BaseDecorator implements Parseable {
  33         /**
  34          * Instance of the parser class
  35          */
  36         private $parserInstance = NULL;
  37
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Creates an instance of the class Parser and prepares it for usage
  50          *
  51          * @param       $innerParserInstance    A Parseable instance
  52          * @return      $parserInstance         An instance of this parser
  53          */
  54         public static final function createXmlCompactorDecorator (Parseable $innerParserInstance) {
  55                 // Get a new instance
  56                 $parserInstance = new XmlCompactorDecorator();
  57
  58                 // Get a new decorator instance for the template engine
  59                 $templateInstance = ObjectFactory::createObjectByConfiguredName('deco_xml_rewriter_template_class', array($innerParserInstance->getTemplateInstance()));
  60
  61                 // Re-set the parser's template instance to the decorator instance
  62                 $innerParserInstance->setTemplateInstance($templateInstance);
  63
  64                 // Set the inner parser instance
  65                 $parserInstance->setParserInstance($innerParserInstance);
  66
  67                 // Return the prepared instance
  68                 return $parserInstance;
  69         }
  70
  71         /**
  72          * Setter for Parseable instance
  73          *
  74          * @param       $parserInstance An instance of an Parseable
  75          * @return      void
  76          */
  77         protected final function setParserInstance (Parseable $parserInstance) {
  78                 $this->parserInstance = $parserInstance;
  79         }
  80
  81         /**
  82          * Getter for Parseable instance
  83          *
  84          * @return      $parserInstance An instance of an Parseable
  85          */
  86         private final function getParserInstance () {
  87                 return $this->parserInstance;
  88         }
  89
  90         /**
  91          * Parses the given XML content
  92          *
  93          * @param       $content        Valid XML content
  94          * @return      void
  95          * @throws      XmlCompactorDecoratorException  If an XML error was found
  96          */
  97         public function parseXmlContent (string $content) {
  98                 // Remove all comments for better compacting
  99                 $content = $this->getParserInstance()->getTemplateInstance()->compactContent($content);
 100
 101                 // Parse the content
 102                 $this->getParserInstance()->parseXmlContent($content);
 103         }
 104
 105 }