X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Ftemplate%2Frequests%2Fclass_XmlRequestNodeListTemplateEngine.php;h=23b16636ccdc90722eee70d955250782aecec00e;hb=c1880f1bd7437bc1c330352a54b90f068fad527b;hp=968a5b928646fc76cde4d59bb6ebd1cb4bfc7d7f;hpb=8e90b922c66aa345f5a6547b2535f90f49310857;p=hub.git diff --git a/application/hub/main/template/requests/class_XmlRequestNodeListTemplateEngine.php b/application/hub/main/template/requests/class_XmlRequestNodeListTemplateEngine.php index 968a5b928..23b16636c 100644 --- a/application/hub/main/template/requests/class_XmlRequestNodeListTemplateEngine.php +++ b/application/hub/main/template/requests/class_XmlRequestNodeListTemplateEngine.php @@ -2,11 +2,11 @@ /** * An ??? template engine class for XML templates * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * @todo This template engine does not make use of setTemplateType() * * This program is free software: you can redistribute it and/or modify @@ -22,24 +22,10 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class XmlRequestNodeListTemplateEngine extends BaseTemplateEngine implements CompileableTemplate, Registerable { - /** - * Main nodes in the XML tree - */ - private $mainNodes = array( - 'node-request-node-list' - ); - - /** - * Sub nodes in the XML tree - */ - private $subNodes = array( - ); - - /** - * Current main node - */ - private $curr = array(); +class XmlRequestNodeListTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable { + // Constants for array elements + const REQUEST_DATA_ACCEPTED_OBJECT_TYPES = 'accepted-object-types'; + const REQUEST_DATA_SESSION_ID = 'session-id'; /** * Protected constructor @@ -49,6 +35,12 @@ class XmlRequestNodeListTemplateEngine extends BaseTemplateEngine implements Com protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Init sub nodes + $this->setSubNodes(array( + self::REQUEST_DATA_ACCEPTED_OBJECT_TYPES, + self::REQUEST_DATA_SESSION_ID, + )); } /** @@ -66,203 +58,92 @@ class XmlRequestNodeListTemplateEngine extends BaseTemplateEngine implements Com // Get a new instance $templateInstance = new XmlRequestNodeListTemplateEngine(); - // Get 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_message_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_request_node_list_stacker_class'); - - // Set it - $templateInstance->setStackerInstance($stackerInstance); + // Init template instance + $templateInstance->initXmlTemplateEngine('node', 'request_node_list'); // Return the prepared instance return $templateInstance; } /** - * Load a specified request_node_list template into the engine + * Currently not used * - * @param $template The request_node_list template we shall load which is - * located in 'node_request_node_list' by default + * @param $resource XML parser resource (currently ignored) + * @param $characters Characters to handle * @return void + * @todo Find something useful with this! */ - 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); - } + public function characterHandler ($resource, $characters) { + // Trim all spaces away + $characters = trim($characters); - /** - * Getter for current main node - * - * @return $currMainNode Current main node - */ - public final function getCurrMainNode () { - return $this->curr['main_node']; - } + // Is this string empty? + if (empty($characters)) { + // Then skip it silently + return; + } // END - if - /** - * 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; + // Assign data with matching variable here + parent::assignVariable($this->getStackInstance()->getNamed('node_request_node_list'), $characters); } /** - * 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 + * Getter for cache file (FQFN) * - * @return $subNodes Array with valid sub node names + * @return $fqfn Full-qualified file name of the menu cache */ - public final function getSubNodes () { - return $this->subNodes; + public function getRequestNodeListCacheFqfn () { + $this->partialStub('Please implement this method.'); } /** - * Handles the start element of an XML resource + * Starts the node-request-node-list * - * @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 = 'initNodeRequestNodeList'; - - // Make the element name lower-case - $element = strtolower($element); - - // Is the element a main node? - //* DEBUG: */ echo "START: >".$element."<
\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); + protected function startRequestNodeList () { + // Push the node name on the stacker + $this->getStackInstance()->pushNamed('node_request_node_list', 'node-request-node-list'); } /** - * Ends the main or sub node by sending out the gathered data + * Starts the accepted-object-types * - * @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: >".$nodeName."<
\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."
\n"; - call_user_func_array(array($this, $methodName), array()); + protected function startAcceptedObjectTypes () { + // Push the node name on the stacker + $this->getStackInstance()->pushNamed('node_request_node_list', self::REQUEST_DATA_ACCEPTED_OBJECT_TYPES); } /** - * Currently not used + * Starts the session-id * - * @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 - - // Get current XML node name as an array index - $nodeName = $this->getStackerInstance()->getNamed('node_request_node_list'); - - $this->partialStub('TODO: Do something with the gathered data.'); + protected function startSessionId () { + // Push the node name on the stacker + $this->getStackInstance()->pushNamed('node_request_node_list', self::REQUEST_DATA_SESSION_ID); } /** - * Getter for cache file (FQFN) + * Finishes the session-id * - * @return $fqfn Full-qualified file name of the menu cache + * @return void */ - public function getNodeRequestNodeListCacheFqfn () { - $this->partialStub('Please implement this method.'); + protected function finishSessionId () { + // Pop the last entry + $this->getStackInstance()->popNamed('node_request_node_list'); } /** - * Starts the node-request-node-list + * Finishes the accepted-object-types * * @return void */ - private function startNodeRequestNodeList () { - // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('node_request_node_list', 'node-request-node-list'); + protected function finishAcceptedObjectTypes () { + // Pop the last entry + $this->getStackInstance()->popNamed('node_request_node_list'); } /** @@ -270,9 +151,9 @@ class XmlRequestNodeListTemplateEngine extends BaseTemplateEngine implements Com * * @return void */ - private function finishNodeRequestNodeList () { + protected function finishRequestNodeList () { // Pop the last entry - $this->getStackerInstance()->popNamed('node_request_node_list'); + $this->getStackInstance()->popNamed('node_request_node_list'); } }