Continued:
[core.git] / framework / main / classes / factories / xml / class_XmlTemplateEngineFactory.php
index 73d455eaac52052e739767cd46d223e4ae68b6d3..f29e271bd03993b01d34acccc5a4e19d380618a0 100644 (file)
@@ -1,10 +1,15 @@
 <?php
 // Own namespace
-namespace CoreFramework\Factory\Template;
+namespace Org\Mxchange\CoreFramework\Factory\Template;
 
 // Import framework stuff
-use CoreFramework\Factory\ObjectFactory;
-use CoreFramework\Registry\Registry;
+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
@@ -13,7 +18,7 @@ use CoreFramework\Registry\Registry;
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @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
  *
@@ -30,13 +35,13 @@ use CoreFramework\Registry\Registry;
  * 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 ObjectFactory {
+class XmlTemplateEngineFactory extends BaseFactory {
        /**
         * Protected constructor
         *
         * @return      void
         */
-       protected function __construct () {
+       private function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }
@@ -46,17 +51,24 @@ class XmlTemplateEngineFactory extends ObjectFactory {
         * the registry it will be returned, else a new instance is created and
         * stored in the same registry entry.
         *
-        * @param       $configEntry            Config entry name for the template engine
+        * @param       $configKey              Config entry name for the template engine
         * @return      $templateInstance       A template engine instance
         */
-       public static final function createXmlTemplateEngineInstance ($configEntry) {
+       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 (Registry::getRegistry()->instanceExists($configEntry)) {
+               if (ObjectRegistry::getRegistry('factory')->instanceExists($configKey)) {
                        // Then use this instance
-                       $templateInstance = Registry::getRegistry()->getInstance($configEntry);
+                       $templateInstance = ObjectRegistry::getRegistry('factory')->getInstance($configKey);
                } else {
-                       // Now prepare the tags instance
-                       $templateInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
+                       // Get the XML template instance
+                       $templateInstance = ObjectFactory::createObjectByConfiguredName($configKey);
 
                        // Disable language support
                        $templateInstance->enableLanguageSupport(false);
@@ -68,10 +80,11 @@ class XmlTemplateEngineFactory extends ObjectFactory {
                        $templateInstance->enableXmlCompacting();
 
                        // Set the instance in registry for further use
-                       Registry::getRegistry()->addInstance($configEntry, $templateInstance);
+                       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;
        }