3 namespace Org\Mxchange\CoreFramework\Factory\Template;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\BaseFactory;
7 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
8 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
11 use \InvalidArgumentException;
14 * A factory class for XML template engines. All instances generated by this
15 * factory does have language support disabled and XML-compacting enabled (to
16 * save memory/network load).
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
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.
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.
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/>.
37 class XmlTemplateEngineFactory extends BaseFactory {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
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.
53 * @param $configKey Config entry name for the template engine
54 * @return $templateInstance A template engine instance
56 public static final function createXmlTemplateEngineInstance (string $configKey) {
58 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-TEMPLATE-ENGINE-FACTORY: configKey=%s - CALLED!', $configKey));
59 if (empty($configKey)) {
61 throw new InvalidArgumentException('Paramter "configKey" is empty');
64 // Do we have an instance in the registry?
65 if (GenericRegistry::getRegistry()->instanceExists($configKey)) {
66 // Then use this instance
67 $templateInstance = GenericRegistry::getRegistry()->getInstance($configKey);
69 // Get the XML template instance
70 $templateInstance = ObjectFactory::createObjectByConfiguredName($configKey);
72 // Disable language support
73 $templateInstance->enableLanguageSupport(false);
76 * Enable compacting/rewriting of the XML to save bandwidth from XML
77 * comments. This is expensive and should be avoided in general.
79 $templateInstance->enableXmlCompacting();
81 // Set the instance in registry for further use
82 GenericRegistry::getRegistry()->addInstance($configKey, $templateInstance);
85 // Return the instance
86 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-TEMPLATE-ENGINE-FACTORY: templateInstance=%s - EXIT!', $templateInstance->__toString()));
87 return $templateInstance;