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\BaseFactory;
   7 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
   8 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   9 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
  10
  11 // Import SPL stuff
  12 use \InvalidArgumentException;
  13
  14 /**
  15  * A factory class for XML template engines. All instances generated by this
  16  * factory does have language support disabled and XML-compacting enabled (to
  17  * save memory/network load).
  18  *
  19  * @author              Roland Haeder <webmaster@shipsimu.org>
  20  * @version             0.0.0
  21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  22  * @license             GNU GPL 3.0 or any newer version
  23  * @link                http://www.shipsimu.org
  24  *
  25  * This program is free software: you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation, either version 3 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License
  36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  37  */
  38 class XmlTemplateEngineFactory extends BaseFactory {
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         private function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47         }
  48
  49         /**
  50          * Returns a singleton network package instance. If an instance is found in
  51          * the registry it will be returned, else a new instance is created and
  52          * stored in the same registry entry.
  53          *
  54          * @param       $configKey              Config entry name for the template engine
  55          * @return      $templateInstance       A template engine instance
  56          */
  57         public static final function createXmlTemplateEngineInstance (string $configKey) {
  58                 // Validate parameter
  59                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-TEMPLATE-ENGINE-FACTORY: configKey=%s - CALLED!', $configKey));
  60                 if (empty($configKey)) {
  61                         // Throw IAE
  62                         throw new InvalidArgumentException('Paramter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
  63                 }
  64
  65                 // Do we have an instance in the registry?
  66                 if (GenericRegistry::getRegistry()->instanceExists($configKey)) {
  67                         // Then use this instance
  68                         $templateInstance = GenericRegistry::getRegistry()->getInstance($configKey);
  69                 } else {
  70                         // Get the XML template instance
  71                         $templateInstance = ObjectFactory::createObjectByConfiguredName($configKey);
  72
  73                         // Disable language support
  74                         $templateInstance->enableLanguageSupport(false);
  75
  76                         /*
  77                          * Enable compacting/rewriting of the  XML to save bandwidth from XML
  78                          * comments. This is expensive and should be avoided in general.
  79                          */
  80                         $templateInstance->enableXmlCompacting();
  81
  82                         // Set the instance in registry for further use
  83                         GenericRegistry::getRegistry()->addInstance($configKey, $templateInstance);
  84                 }
  85
  86                 // Return the instance
  87                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-TEMPLATE-ENGINE-FACTORY: templateInstance=%s - EXIT!', $templateInstance->__toString()));
  88                 return $templateInstance;
  89         }
  90
  91 }