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