]> git.mxchange.org Git - hub.git/commitdiff
Also loadXmlTemplate() is now very generic (so maybe it can be moved to 'core'?)
authorRoland Häder <roland@mxchange.org>
Wed, 22 Aug 2012 21:14:29 +0000 (21:14 +0000)
committerRoland Häder <roland@mxchange.org>
Wed, 22 Aug 2012 21:14:29 +0000 (21:14 +0000)
16 files changed:
.gitattributes
application/hub/main/helper/hub/announcement/class_HubAnnouncementHelper.php
application/hub/main/helper/hub/answer/announcement/class_NodeAnnouncementMessageAnswerHelper.php
application/hub/main/helper/hub/answer/requests/class_NodeRequestNodeListMessageAnswerHelper.php
application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php
application/hub/main/helper/hub/requests/class_NodeRequestNodeListHelper.php
application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php
application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php
application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php
application/hub/main/template/answer/requests/.htaccess [new file with mode: 0644]
application/hub/main/template/answer/requests/class_XmlRequestNodeListAnswerTemplateEngine.php [new file with mode: 0644]
application/hub/main/template/class_BaseXmlTemplateEngine.php
application/hub/main/template/connect/class_XmlSelfConnectTemplateEngine.php
application/hub/main/template/objects/class_XmlObjectRegistryTemplateEngine.php
application/hub/main/template/producer/test_units/class_XmlCruncherTestUnitTemplateEngine.php
application/hub/main/template/requests/class_XmlRequestNodeListTemplateEngine.php

index 86ad56c620edaa9cba9c803f632c89db9034e952..4e96e943b9d8ffe7da1e9ef7c2d62085f463f03d 100644 (file)
@@ -589,6 +589,7 @@ application/hub/main/template/announcement/.htaccess -text svneol=unset#text/pla
 application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php svneol=native#text/plain
 application/hub/main/template/answer/.htaccess -text svneol=unset#text/plain
 application/hub/main/template/answer/announcement/.htaccess -text svneol=unset#text/plain
+application/hub/main/template/answer/requests/.htaccess -text svneol=unset#text/plain
 application/hub/main/template/connect/.htaccess -text svneol=unset#text/plain
 application/hub/main/template/connect/class_XmlSelfConnectTemplateEngine.php svneol=native#text/plain
 application/hub/main/template/objects/.htaccess -text svneol=unset#text/plain
index 1979194b59bccec62eeec05454b7792181fc2826..6e576867312107268a0432e35c6fb6972fbff5b7 100644 (file)
@@ -68,7 +68,7 @@ class HubAnnouncementHelper extends BaseHubHelper implements HelpableHub {
                $this->setTemplateInstance($templateInstance);
 
                // Read the XML descriptor
-               $this->getTemplateInstance()->loadAnnouncementTemplate();
+               $this->getTemplateInstance()->loadXmlTemplate();
 
                // Render the XML content
                $this->getTemplateInstance()->renderXmlContent();
index 67f7f40b1d88af9eed8188710b2a2f2e4a263fce..abd7e024d14483ad33109aa9aafcc6b78acada03 100644 (file)
@@ -72,7 +72,7 @@ class NodeAnnouncementMessageAnswerHelper extends BaseHubAnswerHelper implements
                $this->setTemplateInstance($templateInstance);
 
                // Read the XML descriptor
-               $this->getTemplateInstance()->loadAnnouncementAnswerTemplate();
+               $this->getTemplateInstance()->loadXmlTemplate();
 
                // Render the XML content
                $this->getTemplateInstance()->renderXmlContent();
index a21c969352c1f3758c0c70bdbeb6fb22060d5d4c..8266cb3081abb33d8562001ed3115f7eb6415930 100644 (file)
@@ -72,7 +72,7 @@ class NodeRequestNodeListMessageAnswerHelper extends BaseHubAnswerHelper impleme
                $this->setTemplateInstance($templateInstance);
 
                // Read the XML descriptor
-               $this->getTemplateInstance()->loadRequestNodeListAnswerTemplate();
+               $this->getTemplateInstance()->loadXmlTemplate();
 
                // Render the XML content
                $this->getTemplateInstance()->renderXmlContent();
index 4a5847303f5560482a92c43234e60d7e3b6aa529..2a6c37cd561a426127eb2e2cf21837833adf208c 100644 (file)
@@ -68,7 +68,7 @@ class HubSelfConnectHelper extends BaseHubHelper implements HelpableHub {
                $this->setTemplateInstance($templateInstance);
 
                // Read the XML descriptor
-               $this->getTemplateInstance()->loadSelfConnectTemplate();
+               $this->getTemplateInstance()->loadXmlTemplate();
 
                // Render the XML content
                $this->getTemplateInstance()->renderXmlContent();
index ed31fac0ae6d6dea1282d6ca3ba3bbaf70b03f82..8133f99628de34247457d38c070e272c022c5853 100644 (file)
@@ -68,7 +68,7 @@ class NodeRequestNodeListHelper extends BaseHubHelper implements HelpableHub {
                $this->setTemplateInstance($templateInstance);
 
                // Read the XML descriptor
-               $this->getTemplateInstance()->loadRequestNodeListTemplate();
+               $this->getTemplateInstance()->loadXmlTemplate();
 
                // Render the XML content
                $this->getTemplateInstance()->renderXmlContent();
index 6629b708a4c0aac339eec2a1ce7b7b82ac4c1e1d..fb44300a5b159e0a114ec93a61acbcbe828e2546 100644 (file)
@@ -62,7 +62,7 @@ class CruncherTestUnitProducer extends BaseUnitProducer implements UnitProducer,
                $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('cruncher_test_unit_producer_template_class');
 
                // Load the template
-               $templateInstance->loadCruncherTestUnitTemplate('test_unit');
+               $templateInstance->loadXmlTemplate('test_unit');
 
                // Render the XML content
                $templateInstance->renderXmlContent();
index dde53d35e666b0b19d6b7591dffee30ceb2a48ab..b230b49d955d829f7017c0ef3fe270d3f753f65e 100644 (file)
@@ -80,21 +80,6 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
                return $templateInstance;
        }
 
-       /**
-        * Load a specified announcement template into the engine
-        *
-        * @param       $template       The announcement template we shall load which is
-        *                                              located in 'announcement' by default
-        * @return      void
-        */
-       public function loadAnnouncementTemplate ($template = 'self_announcement') {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *
index 6c613418342cdb2542f63d2a4dafe87efe34e44c..62fc3212c4398a05dc96383e229827e4fbbe0ab9 100644 (file)
@@ -86,21 +86,6 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
                return $templateInstance;
        }
 
-       /**
-        * Load a specified announcement-answer template into the engine
-        *
-        * @param       $template       The announcement-answer template we shall load which is
-        *                                              located in 'announcement_answer' by default
-        * @return      void
-        */
-       public function loadAnnouncementAnswerTemplate ($template = 'announcement_answer') {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_answer_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *
diff --git a/application/hub/main/template/answer/requests/.htaccess b/application/hub/main/template/answer/requests/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
diff --git a/application/hub/main/template/answer/requests/class_XmlRequestNodeListAnswerTemplateEngine.php b/application/hub/main/template/answer/requests/class_XmlRequestNodeListAnswerTemplateEngine.php
new file mode 100644 (file)
index 0000000..20f26e4
--- /dev/null
@@ -0,0 +1,124 @@
+<?php
+/**
+ * An ??? template engine class for XML templates
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ * @todo               This template engine does not make use of setTemplateType()
+ *
+ * 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 XmlRequestNodeListAnswerTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
+       /**
+        * Some XML nodes must be available for later data extraction
+        */
+       const ANNOUNCEMENT_DATA_SESSION_ID    = 'my-session-id';
+
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+
+               // Init sub-nodes array
+               $this->subNodes = array(
+                       self::ANNOUNCEMENT_DATA_SESSION_ID,
+               );
+       }
+
+       /**
+        * Creates an instance of the class TemplateEngine and prepares it for usage
+        *
+        * @return      $templateInstance               An instance of TemplateEngine
+        * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
+        * @throws      InvalidBasePathStringException  If $templateBasePath is no string
+        * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
+        *                                                                                      directory or not found
+        * @throws      BasePathReadProtectedException  If $templateBasePath is
+        *                                                                                      read-protected
+        */
+       public static final function createXmlRequestNodeListAnswerTemplateEngine () {
+               // Get a new instance
+               $templateInstance = new XmlRequestNodeListAnswerTemplateEngine();
+
+               // Init instance
+               $templateInstance->initXmlTemplateEngine('node', 'request_node_list_answer');
+
+               // Return the prepared instance
+               return $templateInstance;
+       }
+
+       /**
+        * Currently not used
+        *
+        * @param       $resource               XML parser resource (currently ignored)
+        * @param       $characters             Characters to handle
+        * @return      void
+        * @todo        Find something useful with this!
+        */
+       public function characterHandler ($resource, $characters) {
+               // Trim all spaces away
+               $characters = trim($characters);
+
+               // Is this string empty?
+               if (empty($characters)) {
+                       // Then skip it silently
+                       return false;
+               } // END - if
+
+               /*
+                * Assign the found characters to variable and use the last entry from
+                * stack as the name.
+                */
+               parent::assignVariable($this->getStackerInstance()->getNamed('request_node_list_answer'), $characters);
+       }
+
+       /**
+        * Getter for cache file (FQFN)
+        *
+        * @return      $fqfn   Full-qualified file name of the menu cache
+        */
+       public function getRequestNodeListAnswerCacheFqfn () {
+               $this->partialStub('Please implement this method.');
+       }
+
+       /**
+        * Starts the announcement-answer
+        *
+        * @return      void
+        */
+       protected function startRequestNodeListAnswer () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('request_node_list_answer', 'announcement-answer');
+       }
+
+       /**
+        * Finishes the announcement-answer
+        *
+        * @return      void
+        */
+       protected function finishRequestNodeListAnswer () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('request_node_list_answer');
+       }
+}
+
+// [EOF]
+?>
index 04af15dfcecebb484518458b31b70c6ebb6e963b..58b990edc68300cb5d10efb2dba8a772df8c90f4 100644 (file)
@@ -129,15 +129,14 @@ class BaseXmlTemplateEngine extends BaseTemplateEngine {
        /**
         * Load a specified XML template into the engine
         *
-        * @param       $template       The XML template we shall load
         * @return      void
         */
-       public function loadXmlTemplate ($template) {
+       public function loadXmlTemplate () {
                // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry($this->xmlTemplateType . '_template_type'));
+               $this->setTemplateType($this->getConfigInstance()->getConfigEntry($this->typePrefix . '_' . $this->xmlTemplateType . '_template_type'));
 
                // Load the special template
-               $this->loadTemplate($template);
+               $this->loadTemplate($this->xmlTemplateType);
        }
 
        /**
index da8df035efb245dad09aab0f4196702215aa6efd..8396117cf022def8b6c2c818c2c89d9b35ca5566 100644 (file)
@@ -68,21 +68,6 @@ class XmlSelfConnectTemplateEngine extends BaseXmlTemplateEngine implements Comp
                return $templateInstance;
        }
 
-       /**
-        * Load a specified self-connect template into the engine
-        *
-        * @param       $template       The self-connect template we shall load which is
-        *                                              located in 'self_connect' by default
-        * @return      void
-        */
-       public function loadSelfConnectTemplate ($template = 'self_connect') {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_self_connect_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *
index 95f5c758d5a89fe58f662f6fd85cbdff464da0b7..d6284a89550b38f81171247a77f0130adeb415a8 100644 (file)
@@ -81,21 +81,6 @@ class XmlObjectRegistryTemplateEngine extends BaseXmlTemplateEngine implements C
                return $templateInstance;
        }
 
-       /**
-        * Load a specified object_registry template into the engine
-        *
-        * @param       $template       The object_registry template we shall load which is
-        *                                              located in 'object_registry' by default
-        * @return      void
-        */
-       public function loadObjectRegistryTemplate ($template = 'object_registry') {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_object_registry_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *
index dbea5dd4018f4e652a30e876f0743b8b12ecdc5c..ea1e631cf08ae77fe7667ba178734883f6e8ff5a 100644 (file)
@@ -71,21 +71,6 @@ class XmlCruncherTestUnitTemplateEngine extends BaseXmlTemplateEngine implements
                return $templateInstance;
        }
 
-       /**
-        * Load a specified cruncher_test_unit template into the engine
-        *
-        * @param       $template       The cruncher_test_unit template we shall load which is
-        *                                              located in 'cruncher_test_unit' by default
-        * @return      void
-        */
-       public function loadCruncherTestUnitTemplate ($template) {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('cruncher_test_unit_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *
index 3762482692bbb6d01bc4f64c5c5fae95da9c1983..2824834285e95c4b9b27b2dc6209eaad7e842267 100644 (file)
@@ -65,21 +65,6 @@ class XmlRequestNodeListTemplateEngine extends BaseXmlTemplateEngine implements
                return $templateInstance;
        }
 
-       /**
-        * Load a specified request_node_list template into the engine
-        *
-        * @param       $template       The request_node_list template we shall load which is
-        *                                              located in 'node_request_node_list' by default
-        * @return      void
-        */
-       public function loadRequestNodeListTemplate ($template = 'node_request_node_list') {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_request_node_list_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *