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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Factory\Template;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   7 use Org\Mxchange\CoreFramework\Registry\Registry;
   8
   9 /**
  10  * A factory class for XML template engines. All instances generated by this
  11  * factory does have language support disabled and XML-compacting enabled (to
  12  * save memory/network load).
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16 <<<<<<< HEAD:framework/main/classes/factories/xml/class_XmlTemplateEngineFactory.php
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18 =======
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  20 >>>>>>> Some updates::inc/main/classes/factories/xml/class_XmlTemplateEngineFactory.php
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.shipsimu.org
  23  *
  24  * This program is free software: you can redistribute it and/or modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation, either version 3 of the License, or
  27  * (at your option) any later version.
  28  *
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License
  35  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  36  */
  37 class XmlTemplateEngineFactory extends ObjectFactory {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Returns a singleton network package instance. If an instance is found in
  50          * the registry it will be returned, else a new instance is created and
  51          * stored in the same registry entry.
  52          *
  53          * @param       $configEntry            Config entry name for the template engine
  54          * @return      $templateInstance       A template engine instance
  55          */
  56         public static final function createXmlTemplateEngineInstance ($configEntry) {
  57                 // Do we have an instance in the registry?
  58                 if (Registry::getRegistry()->instanceExists($configEntry)) {
  59                         // Then use this instance
  60                         $templateInstance = Registry::getRegistry()->getInstance($configEntry);
  61                 } else {
  62                         // Now prepare the tags instance
  63                         $templateInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
  64
  65                         // Disable language support
  66                         $templateInstance->enableLanguageSupport(false);
  67
  68                         /*
  69                          * Enable compacting/rewriting of the  XML to save bandwidth from XML
  70                          * comments. This is expensive and should be avoided in general.
  71                          */
  72                         $templateInstance->enableXmlCompacting();
  73
  74                         // Set the instance in registry for further use
  75                         Registry::getRegistry()->addInstance($configEntry, $templateInstance);
  76                 }
  77
  78                 // Return the instance
  79                 return $templateInstance;
  80         }
  81
  82 }