3 namespace Org\Mxchange\CoreFramework\Parser\Xml;
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;
11 * A XML compacting decorator class for XML parsers
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
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.
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.
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/>.
32 class XmlCompactorDecorator extends BaseDecorator implements Parseable {
34 * Instance of the parser class
36 private $parserInstance = NULL;
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of the class Parser and prepares it for usage
51 * @param $innerParserInstance A Parseable instance
52 * @return $parserInstance An instance of this parser
54 public static final function createXmlCompactorDecorator (Parseable $innerParserInstance) {
56 $parserInstance = new XmlCompactorDecorator();
58 // Get a new decorator instance for the template engine
59 $templateInstance = ObjectFactory::createObjectByConfiguredName('deco_xml_rewriter_template_class', array($innerParserInstance->getTemplateInstance()));
61 // Re-set the parser's template instance to the decorator instance
62 $innerParserInstance->setTemplateInstance($templateInstance);
64 // Set the inner parser instance
65 $parserInstance->setParserInstance($innerParserInstance);
67 // Return the prepared instance
68 return $parserInstance;
72 * Setter for Parseable instance
74 * @param $parserInstance An instance of an Parseable
77 protected final function setParserInstance (Parseable $parserInstance) {
78 $this->parserInstance = $parserInstance;
82 * Getter for Parseable instance
84 * @return $parserInstance An instance of an Parseable
86 private final function getParserInstance () {
87 return $this->parserInstance;
91 * Parses the given XML content
93 * @param $content Valid XML content
95 * @throws XmlCompactorDecoratorException If an XML error was found
97 public function parseXmlContent ($content) {
98 // Remove all comments for better compacting
99 $content = $this->getParserInstance()->getTemplateInstance()->compactContent($content);
102 $this->getParserInstance()->parseXmlContent($content);