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\Generic\BaseDecorator;
   8 use 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 - 2017 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          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of the class Parser and prepares it for usage
  45          *
  46          * @param       $innerParserInstance    A Parseable instance
  47          * @return      $parserInstance         An instance of this parser
  48          */
  49         public static final function createXmlCompactorDecorator (Parseable $innerParserInstance) {
  50                 // Get a new instance
  51                 $parserInstance = new XmlCompactorDecorator();
  52
  53                 // Get a new decorator instance for the template engine
  54                 $templateInstance = ObjectFactory::createObjectByConfiguredName('deco_xml_rewriter_template_class', array($innerParserInstance->getTemplateInstance()));
  55
  56                 // Re-set the parser's template instance to the decorator instance
  57                 $innerParserInstance->setTemplateInstance($templateInstance);
  58
  59                 // Set the inner parser instance
  60                 $parserInstance->setParserInstance($innerParserInstance);
  61
  62                 // Return the prepared instance
  63                 return $parserInstance;
  64         }
  65
  66         /**
  67          * Parses the given XML content
  68          *
  69          * @param       $content        Valid XML content
  70          * @return      void
  71          * @throws      XmlCompactorDecoratorException  If an XML error was found
  72          */
  73         public function parseXmlContent ($content) {
  74                 // Remove all comments for better compacting
  75                 $content = $this->getParserInstance()->getTemplateInstance()->compactContent($content);
  76
  77                 // Parse the content
  78                 $this->getParserInstance()->parseXmlContent($content);
  79         }
  80
  81 }