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

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