From 3a605c14b9df9bfde3c09fb9f3f9a12032f45414 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Roland=20H=C3=A4der?= <roland@mxchange.org>
Date: Tue, 22 Mar 2011 00:10:07 +0000
Subject: [PATCH] Added a XML template engine factory which encapsulates
 disabling of language support and enabling of XML-compacting

---
 .gitattributes                                |  2 +
 inc/classes/main/factories/xml/.htaccess      |  1 +
 .../xml/class_XmlTemplateEngineFactory.php    | 73 +++++++++++++++++++
 3 files changed, 76 insertions(+)
 create mode 100644 inc/classes/main/factories/xml/.htaccess
 create mode 100644 inc/classes/main/factories/xml/class_XmlTemplateEngineFactory.php

diff --git a/.gitattributes b/.gitattributes
index 2f1dff57..bc49187f 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -355,6 +355,8 @@ inc/classes/main/factories/registry/.htaccess -text svneol=unset#text/plain
 inc/classes/main/factories/registry/class_SocketRegistryFactory.php svneol=native#text/plain
 inc/classes/main/factories/web/.htaccess -text svneol=unset#text/plain
 inc/classes/main/factories/web/class_WebNewsFactory.php -text svneol=unset#text/plain
+inc/classes/main/factories/xml/.htaccess svneol=native#text/plain
+inc/classes/main/factories/xml/class_XmlTemplateEngineFactory.php svneol=native#text/plain
 inc/classes/main/filter/.htaccess -text svneol=unset#text/plain
 inc/classes/main/filter/auth/.htaccess -text svneol=unset#text/plain
 inc/classes/main/filter/auth/class_UserAuthFilter.php -text svneol=unset#text/plain
diff --git a/inc/classes/main/factories/xml/.htaccess b/inc/classes/main/factories/xml/.htaccess
new file mode 100644
index 00000000..3a428827
--- /dev/null
+++ b/inc/classes/main/factories/xml/.htaccess
@@ -0,0 +1 @@
+Deny from all
diff --git a/inc/classes/main/factories/xml/class_XmlTemplateEngineFactory.php b/inc/classes/main/factories/xml/class_XmlTemplateEngineFactory.php
new file mode 100644
index 00000000..6e1f41eb
--- /dev/null
+++ b/inc/classes/main/factories/xml/class_XmlTemplateEngineFactory.php
@@ -0,0 +1,73 @@
+<?php
+/**
+ * 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@ship-simu.org>
+ * @version		0.0.0
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @license		GNU GPL 3.0 or any newer version
+ * @link		http://www.ship-simu.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 ObjectFactory {
+	/**
+	 * Protected constructor
+	 *
+	 * @return	void
+	 */
+	protected 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	$configEntry		Config entry name for the template engine
+	 * @return	$templateInstance	A template engine instance
+	 */
+	public static final function createXmlTemplateEngineInstance ($configEntry) {
+		// Do we have an instance in the registry?
+		if (Registry::getRegistry()->instanceExists($configEntry)) {
+			// Then use this instance
+			$templateInstance = Registry::getRegistry()->getInstance($configEntry);
+		} else {
+			// Now prepare the tags instance
+			$templateInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
+
+			// 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
+			Registry::getRegistry()->addInstance($configEntry, $templateInstance);
+		}
+
+		// Return the instance
+		return $templateInstance;
+	}
+}
+
+// [EOF]
+?>
-- 
2.39.2