]> git.mxchange.org Git - hub.git/blobdiff - application/hub/main/template/objects/class_XmlObjectRegistryTemplateEngine.php
Refactured a lot methods to become more generic (eventually BaseXmlTemplateEngine...
[hub.git] / application / hub / main / template / objects / class_XmlObjectRegistryTemplateEngine.php
index c9eb4468fec1be98953ad58ab1bce3a34335c6fe..0a691ae8aee548e1362190539c5798f6534e45c8 100644 (file)
@@ -35,36 +35,6 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp
         */
        private $objectRegistryInstance = NULL;
 
-       /**
-        * Main nodes in the XML tree
-        */
-       private $mainNodes = array(
-               'object-registry'
-       );
-
-       /**
-        * Sub nodes in the XML tree
-        */
-       private $subNodes = array(
-               'object-list',
-               'object-list-entry',
-               self::OBJECT_TYPE_DATA_NAME,
-               self::OBJECT_TYPE_DATA_RECIPIENT_LIMITATION,
-               self::OBJECT_TYPE_DATA_MAX_SPREAD,
-               self::OBJECT_TYPE_DATA_PROTOCOL,
-               self::OBJECT_TYPE_DATA_RECIPIENT_TYPE
-       );
-
-       /**
-        * Current main node
-        */
-       private $curr = array();
-
-       /**
-        * Content from dependency
-        */
-       private $dependencyContent = array();
-
        /**
         * Protected constructor
         *
@@ -76,6 +46,17 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp
 
                // Init object type registry instance
                $this->objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
+
+               // Init sub nodes
+               $this->subNodes = array(
+                       'object-list',
+                       'object-list-entry',
+                       self::OBJECT_TYPE_DATA_NAME,
+                       self::OBJECT_TYPE_DATA_RECIPIENT_LIMITATION,
+                       self::OBJECT_TYPE_DATA_MAX_SPREAD,
+                       self::OBJECT_TYPE_DATA_PROTOCOL,
+                       self::OBJECT_TYPE_DATA_RECIPIENT_TYPE
+               );
        }
 
        /**
@@ -93,42 +74,8 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp
                // Get a new instance
                $templateInstance = new XmlObjectRegistryTemplateEngine();
 
-               // Get the application instance from registry
-               $applicationInstance = Registry::getRegistry()->getInstance('app');
-
-               // Determine base path
-               $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
-
-               // Is the base path valid?
-               if (empty($templateBasePath)) {
-                       // Base path is empty
-                       throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } elseif (!is_string($templateBasePath)) {
-                       // Is not a string
-                       throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
-               } elseif (!is_dir($templateBasePath)) {
-                       // Is not a path
-                       throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
-               } elseif (!is_readable($templateBasePath)) {
-                       // Is not readable
-                       throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
-               }
-
-               // Set the base path
-               $templateInstance->setTemplateBasePath($templateBasePath);
-
-               // Set template extensions
-               $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
-               $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('node_object_registry_template_extension'));
-
-               // Absolute output path for compiled templates
-               $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
-
-               // Init a variable stacker
-               $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_object_registry_stacker_class');
-
-               // Set it
-               $templateInstance->setStackerInstance($stackerInstance);
+               // Init template instance
+               $templateInstance->initXmlTemplateEngine('node', 'object_registry');
 
                // Return the prepared instance
                return $templateInstance;
@@ -141,7 +88,7 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp
         *                                              located in 'object_registry' by default
         * @return      void
         */
-       public function loadObjectRegistryTemplate ($template) {
+       public function loadObjectRegistryTemplate ($template = 'object_registry') {
                // Set template type
                $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_object_registry_template_type'));
 
@@ -149,106 +96,6 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp
                $this->loadTemplate($template);
        }
 
-       /**
-        * Getter for current main node
-        *
-        * @return      $currMainNode   Current main node
-        */
-       public final function getCurrMainNode () {
-               return $this->curr['main_node'];
-       }
-
-       /**
-        * Setter for current main node
-        *
-        * @param       $element                Element name to set as current main node
-        * @return      $currMainNode   Current main node
-        */
-       private final function setCurrMainNode ($element) {
-               $this->curr['main_node'] = (string) $element;
-       }
-
-       /**
-        * Getter for main node array
-        *
-        * @return      $mainNodes      Array with valid main node names
-        */
-       public final function getMainNodes () {
-               return $this->mainNodes;
-       }
-
-       /**
-        * Getter for sub node array
-        *
-        * @return      $subNodes       Array with valid sub node names
-        */
-       public final function getSubNodes () {
-               return $this->subNodes;
-       }
-
-       /**
-        * Handles the start element of an XML resource
-        *
-        * @param       $resource               XML parser resource (currently ignored)
-        * @param       $element                The element we shall handle
-        * @param       $attributes             All attributes
-        * @return      void
-        * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
-        */
-       public function startElement ($resource, $element, array $attributes) {
-               // Initial method name which will never be called...
-               $methodName = 'initObjectRegistry';
-
-               // Make the element name lower-case
-               $element = strtolower($element);
-
-               // Is the element a main node?
-               //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
-               if (in_array($element, $this->getMainNodes())) {
-                       // Okay, main node found!
-                       $methodName = 'start' . $this->convertToClassName($element);
-
-                       // Set it
-                       $this->setCurrMainNode($element);
-               } elseif (in_array($element, $this->getSubNodes())) {
-                       // Sub node found
-                       $methodName = 'start' . $this->convertToClassName($element);
-               } else {
-                       // Invalid node name found
-                       throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
-               }
-
-               // Call method
-               call_user_func_array(array($this, $methodName), $attributes);
-       }
-
-       /**
-        * Ends the main or sub node by sending out the gathered data
-        *
-        * @param       $resource       An XML resource pointer (currently ignored)
-        * @param       $nodeName       Name of the node we want to finish
-        * @return      void
-        * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
-        */
-       public function endElement ($resource, $nodeName) {
-               // Make all lower-case
-               $nodeName = strtolower($nodeName);
-
-               // Does this match with current main node?
-               //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
-               if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
-                       // Did not match!
-                       throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
-               } // END - if
-
-               // Construct method name
-               $methodName = 'finish' . $this->convertToClassName($nodeName);
-
-               // Call the corresponding method
-               //* DEBUG: */ echo "call: ".$methodName."<br />\n";
-               call_user_func_array(array($this, $methodName), array());
-       }
-
        /**
         * Currently not used
         *
@@ -280,30 +127,6 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp
                $this->objectRegistryInstance->addEntry($nodeName, $characters);
        }
 
-       /**
-        * Handles the template dependency for given node
-        *
-        * @param       $node                                   The node we should load a dependency template
-        * @param       $templateDependency             A template to load to satisfy dependencies
-        * @return      void
-        */
-       private function handleTemplateDependency ($node, $templateDependency) {
-               // Is the template dependency set?
-               if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
-                       // Get a temporay template instance
-                       $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_object_registry_template_class');
-
-                       // Then load it
-                       $templateInstance->loadObjectRegistryTemplate($templateDependency);
-
-                       // Parse the XML content
-                       $templateInstance->renderXmlContent();
-
-                       // Save the parsed raw content in our dependency array
-                       $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
-               } // END - if
-       }
-
        /**
         * Getter for cache file (FQFN)
         *