inc/main/classes/decorator/xml/class_XmlCompactorDecorator.php

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