framework/main/classes/decorator/xml/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\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 <<<<<<< HEAD:framework/main/classes/decorator/xml/class_XmlCompactorDecorator.php
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  17 =======
  18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  19 >>>>>>> Some updates::inc/main/classes/decorator/xml/class_XmlCompactorDecorator.php
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.shipsimu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class XmlCompactorDecorator extends BaseDecorator implements Parseable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of the class Parser and prepares it for usage
  49          *
  50          * @param       $innerParserInstance    A Parseable instance
  51          * @return      $parserInstance         An instance of this parser
  52          */
  53         public static final function createXmlCompactorDecorator (Parseable $innerParserInstance) {
  54                 // Get a new instance
  55                 $parserInstance = new XmlCompactorDecorator();
  56
  57                 // Get a new decorator instance for the template engine
  58                 $templateInstance = ObjectFactory::createObjectByConfiguredName('deco_xml_rewriter_template_class', array($innerParserInstance->getTemplateInstance()));
  59
  60                 // Re-set the parser's template instance to the decorator instance
  61                 $innerParserInstance->setTemplateInstance($templateInstance);
  62
  63                 // Set the inner parser instance
  64                 $parserInstance->setParserInstance($innerParserInstance);
  65
  66                 // Return the prepared instance
  67                 return $parserInstance;
  68         }
  69
  70         /**
  71          * Parses the given XML content
  72          *
  73          * @param       $content        Valid XML content
  74          * @return      void
  75          * @throws      XmlCompactorDecoratorException  If an XML error was found
  76          */
  77         public function parseXmlContent ($content) {
  78                 // Remove all comments for better compacting
  79                 $content = $this->getParserInstance()->getTemplateInstance()->compactContent($content);
  80
  81                 // Parse the content
  82                 $this->getParserInstance()->parseXmlContent($content);
  83         }
  84
  85 }