inc/main/classes/factories/xml/class_XmlTemplateEngineFactory.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory\Template;
   4
   5 // Import framework stuff
   6 use CoreFramework\Registry\Generic\Registry;
   7
   8 /**
   9  * A factory class for XML template engines. All instances generated by this
  10  * factory does have language support disabled and XML-compacting enabled (to
  11  * save memory/network load).
  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 XmlTemplateEngineFactory extends ObjectFactory {
  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          * Returns a singleton network package instance. If an instance is found in
  45          * the registry it will be returned, else a new instance is created and
  46          * stored in the same registry entry.
  47          *
  48          * @param       $configEntry            Config entry name for the template engine
  49          * @return      $templateInstance       A template engine instance
  50          */
  51         public static final function createXmlTemplateEngineInstance ($configEntry) {
  52                 // Do we have an instance in the registry?
  53                 if (Registry::getRegistry()->instanceExists($configEntry)) {
  54                         // Then use this instance
  55                         $templateInstance = Registry::getRegistry()->getInstance($configEntry);
  56                 } else {
  57                         // Now prepare the tags instance
  58                         $templateInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
  59
  60                         // Disable language support
  61                         $templateInstance->enableLanguageSupport(FALSE);
  62
  63                         /*
  64                          * Enable compacting/rewriting of the  XML to save bandwidth from XML
  65                          * comments. This is expensive and should be avoided in general.
  66                          */
  67                         $templateInstance->enableXmlCompacting();
  68
  69                         // Set the instance in registry for further use
  70                         Registry::getRegistry()->addInstance($configEntry, $templateInstance);
  71                 }
  72
  73                 // Return the instance
  74                 return $templateInstance;
  75         }
  76
  77 }