X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fmenu%2Fclass_MenuTemplateEngine.php;h=7b638fbffeb1cdda9d2ef2ba9b18ee5a4bced7ba;hb=2e80331da79b13c3094f9039d4c584e3e4b89894;hp=32c92ea127cff59eeeda8935ac47e0d84d6a2f46;hpb=fe5cbde27a571db160694ebb0eb9be02af57dd5a;p=core.git diff --git a/inc/classes/main/template/menu/class_MenuTemplateEngine.php b/inc/classes/main/template/menu/class_MenuTemplateEngine.php index 32c92ea1..7b638fbf 100644 --- a/inc/classes/main/template/menu/class_MenuTemplateEngine.php +++ b/inc/classes/main/template/menu/class_MenuTemplateEngine.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team + * @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 * @@ -26,32 +26,51 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla * Main nodes in the XML tree ('menu' is ignored) */ private $mainNodes = array( - 'header', - 'entries', - 'footer', + 'block-list', ); /** * Sub nodes in the XML tree */ private $subNodes = array( - 'title', + 'entry-list', 'entry', - 'anchor', + 'entry-id', + 'entries-content', + 'block-header', + 'block-footer', + 'footer-id', + 'footer-class', + 'footer-text', + 'block', + 'title', + 'title-id', + 'title-class', + 'title-text', 'design', 'text', 'advert', + 'anchor', + 'anchor-id', + 'anchor-text', + 'anchor-title', + 'anchor-href', ); /** * Menu instance */ - private $menuInstance = null; + private $menuInstance = NULL; /** * Current main node */ - private $currMainNode = ''; + private $curr = array(); + + /** + * Content from dependency + */ + private $dependencyContent = array(); /** * Protected constructor @@ -66,9 +85,8 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla /** * Creates an instance of the class TemplateEngine and prepares it for usage * - * @param $appInstance A manageable application - * @param $menuInstance A RenderableMenu instance - * @return $tplInstance An instance of TemplateEngine + * @param $menuInstance A RenderableMenu instance + * @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 @@ -76,54 +94,52 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla * @throws BasePathReadProtectedException If $templateBasePath is * read-protected */ - public final static function createMenuTemplateEngine (ManageableApplication $appInstance, RenderableMenu $menuInstance) { + public static final function createMenuTemplateEngine (RenderableMenu $menuInstance) { // Get a new instance - $tplInstance = new MenuTemplateEngine(); + $templateInstance = new MenuTemplateEngine(); - // Get language and file I/O instances from application - $langInstance = $appInstance->getLanguageInstance(); - $ioInstance = $appInstance->getFileIoInstance(); + // Get the application instance from registry + $applicationInstance = Registry::getRegistry()->getInstance('app'); // Determine base path - $templateBasePath = $tplInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/'; + $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($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING); + throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING); } elseif (!is_string($templateBasePath)) { // Is not a string - throw new InvalidBasePathStringException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING); + throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING); } elseif (!is_dir($templateBasePath)) { // Is not a path - throw new BasePathIsNoDirectoryException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME); + throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME); } elseif (!is_readable($templateBasePath)) { // Is not readable - throw new BasePathReadProtectedException(array($tplInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH); + throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH); } - // Get configuration instance - $configInstance = FrameworkConfiguration::getInstance(); - // Set the base path - $tplInstance->setTemplateBasePath($templateBasePath); - - // Set the language and IO instances - $tplInstance->setLanguageInstance($langInstance); - $tplInstance->setFileIoInstance($ioInstance); + $templateInstance->setTemplateBasePath($templateBasePath); // Set template extensions - $tplInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension')); - $tplInstance->setCodeTemplateExtension($configInstance->getConfigEntry('menu_template_extension')); + $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension')); + $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('menu_template_extension')); // Absolute output path for compiled templates - $tplInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path')); + $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path')); // Set the menu instance - $tplInstance->setMenuInstance($menuInstance); + $templateInstance->setMenuInstance($menuInstance); + + // Init a variable stacker + $stackerInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class'); + + // Set it + $templateInstance->setStackerInstance($stackerInstance); // Return the prepared instance - return $tplInstance; + return $templateInstance; } /** @@ -147,7 +163,17 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla * @return $currMainNode Current main node */ public final function getCurrMainNode () { - return $this->currMainNode; + 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; } /** @@ -188,13 +214,13 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla //* DEBUG: */ echo "START: >".$element."<
\n"; if (in_array($element, $this->getMainNodes())) { // Okay, main node found! - $methodName = 'startMenu' . $this->convertToClassName($element); + $methodName = 'start' . $this->convertToClassName($element); // Set it - $this->currMainNode = $element; + $this->setCurrMainNode($element); } elseif (in_array($element, $this->getSubNodes())) { // Sub node found - $methodName = 'setMenuProperty' . $this->convertToClassName($element); + $methodName = 'start' . $this->convertToClassName($element); } elseif ($element != 'menu') { // Invalid node name found throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN); @@ -213,7 +239,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla * @return void * @throws XmlNodeMismatchException If current main node mismatches the closing one */ - public function endElement ($resource, $nodeName) { + public function finishElement ($resource, $nodeName) { // Make all lower-case $nodeName = strtolower($nodeName); @@ -229,7 +255,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla // Call the corresponding method //* DEBUG: */ echo "call: ".$methodName."
\n"; - call_user_func_array(array($this->getMenuInstance(), $methodName), array()); + call_user_func_array(array($this, $methodName), array()); } /** @@ -247,22 +273,445 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla // Is this string empty? if (empty($characters)) { // Then skip it silently - return false; + return; } // END - if - // Unfinished work! - $this->partialStub("Handling extra characters is not yet supported!"); + // Assign the found characters to variable and use the last entry from + // stack as the name + parent::assignVariable($this->getStackerInstance()->getNamed('current_node'), $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 menu template instance + $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this->getMenuInstance())); + + // Then load it + $templateInstance->loadMenuTemplate($templateDependency); + + // Parse the XML content + $templateInstance->renderXmlContent(); + + // Save the parsed raw content in our dependency array + $this->dependencyContent[$node] = $templateInstance->getRawTemplateData(); + } // END - if } /** * Intializes the menu * + * @param $templateDependency A template to load to satisfy dependencies * @return void * @todo Add cache creation here */ - private function initMenu () { - // Unfinished work! - $this->partialStub('Please implement this method.'); + private function initMenu ($templateDependency = '') { + // Get web template engine + $this->setTemplateInstance(ObjectFactory::createObjectByConfiguredName('web_template_class', array($this->getApplicationInstance()))); + + // Handle the dependency template + $this->handleTemplateDependency('menu', $templateDependency); + + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'menu'); + } + + /** + * Starts the menu entries + * + * @param $templateDependency A template to load to satisfy dependencies + * @return void + */ + private function startEntryList () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'entry-list'); + } + + /** + * Starts the menu block header + * + * @return void + */ + private function startBlockHeader () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block-header'); + } + + /** + * Starts the menu block footer + * + * @return void + */ + private function startBlockFooter () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block-footer'); + } + + /** + * Starts the menu property 'block-list' + * + * @return void + */ + private function startBlockList () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block-list'); + } + + /** + * Starts the menu property 'block' + * + * @return void + */ + private function startBlock () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block'); + } + + /** + * Starts the menu property 'title' + * + * @return void + */ + private function startTitle () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'title'); + } + + /** + * Starts the menu property 'title-id' + * + * @return void + */ + private function startTitleId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'title-id'); + } + + /** + * Starts the menu property 'title-class' + * + * @return void + */ + private function startTitleClass () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'title-class'); + } + + /** + * Starts the menu property 'title-text' + * + * @return void + */ + private function startTitleText () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'title-text'); + } + + /** + * Starts the menu property 'entry' + * + * @return void + */ + private function startEntry () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'entry'); + } + + /** + * Starts the menu property 'entry-id' + * + * @return void + */ + private function startEntryId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'entry-id'); + } + + /** + * Starts the menu property 'anchor' + * + * @return void + */ + private function startAnchor () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor'); + } + + /** + * Starts the menu property 'anchor-id' + * + * @return void + */ + private function startAnchorId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor-id'); + } + + /** + * Starts the menu property 'anchor-text' + * + * @return void + */ + private function startAnchorText () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor-text'); + } + + /** + * Starts the menu property 'anchor-title' + * + * @return void + */ + private function startAnchorTitle () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor-title'); + } + + /** + * Starts the menu property 'anchor-href' + * + * @return void + */ + private function startAnchorHref () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor-href'); + } + + /** + * Starts the menu property 'footer-id' + * + * @return void + */ + private function startFooterId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'footer-id'); + } + + /** + * Starts the menu property 'footer-class' + * + * @return void + */ + private function startFooterClass () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'footer-class'); + } + + /** + * Starts the menu property 'footer-text' + * + * @return void + */ + private function startFooterText () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'footer-text'); + } + + /** + * Finishes the title node by added another template to the menu + * + * @return void + */ + private function finishTitle () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the title-id node by + * + * @return void + */ + private function finishTitleId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the title-class node + * + * @return void + */ + private function finishTitleClass () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the title-class node + * + * @return void + */ + private function finishTitleText () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the footer-text node + * + * @return void + */ + private function finishFooterText () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the footer-class node + * + * @return void + */ + private function finishFooterClass () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the footer-id node + * + * @return void + */ + private function finishFooterId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the anchor-href node + * + * @return void + */ + private function finishAnchorHref () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the anchor-title node + * + * @return void + */ + private function finishAnchorTitle () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the anchor-text node + * + * @return void + */ + private function finishAnchorText () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the anchor-id node + * + * @return void + */ + private function finishAnchorId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the anchor node + * + * @return void + */ + private function finishAnchor () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the entry-id node + * + * @return void + */ + private function finishEntryId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the entry node + * + * @return void + */ + private function finishEntry () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the block node + * + * @return void + */ + private function finishBlock () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the block-list node + * + * @return void + */ + private function finishBlockList () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the menu entries + * + * @return void + */ + private function finishEntryList () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the menu block header + * + * @return void + */ + private function finishBlockHeader () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the menu block footer + * + * @return void + */ + private function finishBlockFooter () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } + + /** + * Finishes the menu + * + * @return void + */ + private function finishMenu () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /** @@ -277,7 +726,9 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla $this->getGenericBasePath(), 'menus/_cache', md5( - $this->getMenuInstance()->getMenuName() . ':' . $this->__toString() . ':' . $this->getMenuInstance()->__toString() + $this->getMenuInstance()->getMenuName() . ':' . + $this->__toString() . ':' . + $this->getMenuInstance()->__toString() ), $this->getMenuInstance()->getMenuType() );