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