<?php
// Own namespace
namespace Org\Mxchange\CoreFramework\Factory\Template;

// Import framework stuff
use Org\Mxchange\CoreFramework\Factory\BaseFactory;
use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
use Org\Mxchange\CoreFramework\Registry\Object\ObjectRegistry;

// Import SPL stuff
use \InvalidArgumentException;

/**
 * A factory class for XML template engines. All instances generated by this
 * factory does have language support disabled and XML-compacting enabled (to
 * save memory/network load).
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
class XmlTemplateEngineFactory extends BaseFactory {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	private function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Returns a singleton network package instance. If an instance is found in
	 * the registry it will be returned, else a new instance is created and
	 * stored in the same registry entry.
	 *
	 * @param	$configKey		Config entry name for the template engine
	 * @return	$templateInstance	A template engine instance
	 */
	public static final function createXmlTemplateEngineInstance (string $configKey) {
		// Validate parameter
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-TEMPLATE-ENGINE-FACTORY: configKey=%s - CALLED!', $configKey));
		if (empty($configKey)) {
			// Throw IAE
			throw new InvalidArgumentException('Paramter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
		}

		// Do we have an instance in the registry?
		if (ObjectRegistry::getRegistry('factory')->instanceExists($configKey)) {
			// Then use this instance
			$templateInstance = ObjectRegistry::getRegistry('factory')->getInstance($configKey);
		} else {
			// Get the XML template instance
			$templateInstance = ObjectFactory::createObjectByConfiguredName($configKey);

			// Disable language support
			$templateInstance->enableLanguageSupport(false);

			/*
			 * Enable compacting/rewriting of the  XML to save bandwidth from XML
			 * comments. This is expensive and should be avoided in general.
			 */
			$templateInstance->enableXmlCompacting();

			// Set the instance in registry for further use
			ObjectRegistry::getRegistry('factory')->addInstance($configKey, $templateInstance);
		}

		// Return the instance
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('XML-TEMPLATE-ENGINE-FACTORY: templateInstance=%s - EXIT!', $templateInstance->__toString()));
		return $templateInstance;
	}

}