X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fmenu%2Fclass_MenuTemplateEngine.php;h=b67f7207d6bf6da2270ad2a86f41d1b8044b9e76;hp=f12b4700b8702850a9ecacb0df0d6cc199406c6b;hb=57504c3b82b58010c555494d0e3acea1b654b0ef;hpb=f9100a45eb170c0de46b9f73e88508b03ede00d0 diff --git a/inc/classes/main/template/menu/class_MenuTemplateEngine.php b/inc/classes/main/template/menu/class_MenuTemplateEngine.php index f12b4700..b67f7207 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 - 2011 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -26,22 +26,35 @@ 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( + 'entry-list', + 'entry', + 'entry-id', 'entries-content', + 'block-header', + 'block-footer', + 'footer-id', + 'footer-class', + 'footer-text', + 'block', 'title', - 'entry', - 'anchor', + 'title-id', + 'title-class', + 'title-text', 'design', 'text', 'advert', + 'anchor', + 'anchor-id', + 'anchor-text', + 'anchor-title', + 'anchor-href', ); /** @@ -55,9 +68,9 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla private $curr = array(); /** - * Content from depency + * Content from dependency */ - private $depencyContent = array(); + private $dependencyContent = array(); /** * Protected constructor @@ -72,9 +85,9 @@ 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 $applicationInstance A manageable application + * @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 @@ -82,54 +95,49 @@ 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 (ManageableApplication $applicationInstance, RenderableMenu $menuInstance) { // Get a new instance - $tplInstance = new MenuTemplateEngine(); - - // Get language and file I/O instances from application - $langInstance = $appInstance->getLanguageInstance(); - $ioInstance = $appInstance->getFileIoInstance(); + $templateInstance = new MenuTemplateEngine(); // 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; } /** @@ -204,13 +212,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->setCurrMainNode($element); } elseif (in_array($element, $this->getSubNodes())) { // Sub node found - $methodName = 'startMenu' . $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); @@ -266,211 +274,242 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla return false; } // END - if - // Unfinished work! - $this->partialStub('Handling extra characters is not yet supported! length='.strlen($characters)); + // 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 depency for given node + * Handles the template dependency for given node * - * @param $node The node we should load a depency template - * @param $templateDepency A template to load to satisfy depencies + * @param $node The node we should load a dependency template + * @param $templateDependency A template to load to satisfy dependencies * @return void */ - private function handleTemplateDepency ($node, $templateDepency) { - // Is the template depency set? - if ((!empty($templateDepency)) && (!isset($this->depencyContent[$node]))) { + 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->getApplicationInstance(), $this->getMenuInstance())); // Then load it - $templateInstance->loadMenuTemplate($templateDepency); + $templateInstance->loadMenuTemplate($templateDependency); - // Get an XmlParser instance + // Parse the XML content $templateInstance->renderXmlContent(); - // Parse the template's content contents - $this->depencyContent[$node] = $templateInstance->getRawTemplateData(); + // Save the parsed raw content in our dependency array + $this->dependencyContent[$node] = $templateInstance->getRawTemplateData(); } // END - if } /** * Intializes the menu * - * @param $templateDepency A template to load to satisfy depencies + * @param $templateDependency A template to load to satisfy dependencies * @return void * @todo Add cache creation here */ - private function initMenu ($templateDepency = '') { + private function initMenu ($templateDependency = '') { // Get web template engine $this->setTemplateInstance(ObjectFactory::createObjectByConfiguredName('web_template_class', array($this->getApplicationInstance()))); - // Handle the depency template - $this->handleTemplateDepency('menu', $templateDepency); - - // Load the header template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_global_start'); - - // Set the variable group to page - $this->setVariableGroup('menu'); + // Handle the dependency template + $this->handleTemplateDependency('menu', $templateDependency); - // Set its content in this template instance - $this->assignVariable('menu_start', $this->getTemplateInstance()->getRawTemplateData()); + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'menu'); } /** - * Finishes the menu + * Starts the menu entries * + * @param $templateDependency A template to load to satisfy dependencies * @return void */ - private function finishMenu () { - // Load the header template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_global_end'); - - // Set the variable group to page - $this->setVariableGroup('menu'); - - // Set its content in this template instance - $this->assignVariable('menu_end', $this->getTemplateInstance()->getRawTemplateData()); + private function startEntryList () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'entry-list'); } /** - * Starts the menu entries by loading a (maybe) provided template depency + * Starts the menu block header * - * @param $templateDepency A template to load to satisfy depencies * @return void */ - private function startMenuEntries ($templateDepency = '') { - // Handle the depency template - $this->handleTemplateDepency('entries', $templateDepency); - - // Load the header template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_entries_start'); - - // Set the variable group to page - $this->setVariableGroup('menu'); - - // Set its content in this template instance - $this->assignVariable('entries_start', $this->getTemplateInstance()->getRawTemplateData()); + private function startBlockHeader () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block-header'); } /** - * Finishes the menu entries + * Starts the menu block footer * * @return void */ - private function finishEntries () { - // Load the header template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_entries_end'); - - // Set the variable group to page - $this->setVariableGroup('menu'); - - // Set its content in this template instance - $this->assignVariable('entries_end', $this->getTemplateInstance()->getRawTemplateData()); + private function startBlockFooter () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block-footer'); } /** - * Starts the menu header + * Starts the menu property 'block-list' * * @return void */ - private function startMenuHeader () { - // Do we have a template instance? - if (is_null($this->getTemplateInstance())) { - // Init template instance for underlaying web templates - $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class'); - - // Set it in this template engine - $this->setTemplateInstance($templateInstance); - } // END - if - - // Load the header template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_header_start'); - - // Set the variable group to page - $this->setVariableGroup('menu'); - - // Set its content in this template instance - $this->assignVariable('header', $this->getTemplateInstance()->getRawTemplateData()); + private function startBlockList () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block-list'); } /** - * Finishes the menu header + * Starts the menu property 'block' * * @return void */ - private function finishHeader () { - // Load the header template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_header_end'); + private function startBlock () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'block'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * Starts the menu property 'title' + * + * @return void + */ + private function startTitle () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'title'); + } - // Set its content in this template instance - $this->assignVariable('header_end', $this->getTemplateInstance()->getRawTemplateData()); + /** + * 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 footer + * Starts the menu property 'title-class' * * @return void */ - private function startMenuFooter () { - // Do we have a template instance? - if (is_null($this->getTemplateInstance())) { - // Init template instance for underlaying web templates - $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class'); + private function startTitleClass () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'title-class'); + } - // Set it in this template engine - $this->setTemplateInstance($templateInstance); - } // END - if + /** + * 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'); + } - // Load the footer template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_footer_start'); + /** + * Starts the menu property 'entry' + * + * @return void + */ + private function startEntry () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'entry'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * 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'); + } - // Set its content in this template instance - $this->assignVariable('footer', $this->getTemplateInstance()->getRawTemplateData()); + /** + * Starts the menu property 'anchor' + * + * @return void + */ + private function startAnchor () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor'); } /** - * Finishes the menu footer + * Starts the menu property 'anchor-id' * * @return void */ - private function finishFooter () { - // Load the footer template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_footer_end'); + private function startAnchorId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor-id'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * 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'); + } - // Set its content in this template instance - $this->assignVariable('footer_end', $this->getTemplateInstance()->getRawTemplateData()); + /** + * 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 'title' + * Starts the menu property 'anchor-href' * - * @param $id Id of the menu - * @param $class The title to add to the menu * @return void */ - private function startMenuTitle ($id, $class) { - // Set id as current - $this->curr['id'] = $id; + private function startAnchorHref () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('current_node', 'anchor-href'); + } - // Load the title template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_title_' . $id . '_start'); + /** + * 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'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * 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'); + } - // Set its content in this template instance - $this->assignVariable('title_start_' . $this->curr['id'], $this->getTemplateInstance()->getRawTemplateData()); + /** + * 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'); } /** @@ -479,111 +518,198 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla * @return void */ private function finishTitle () { - // Load the title template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_title_' . $this->curr['id'] . '_end'); + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * Finishes the title-id node by + * + * @return void + */ + private function finishTitleId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set its content in this template instance - $this->assignVariable('title_end_' . $this->curr['id'], $this->getTemplateInstance()->getRawTemplateData()); + /** + * Finishes the title-class node + * + * @return void + */ + private function finishTitleClass () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /** - * Starts the menu text + * Finishes the title-class node * * @return void */ - private function startMenuText () { - // Do we have a template instance? - if (is_null($this->getTemplateInstance())) { - // Init template instance for underlaying web templates - $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class'); + private function finishTitleText () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set it in this template engine - $this->setTemplateInstance($templateInstance); - } // END - if + /** + * Finishes the footer-text node + * + * @return void + */ + private function finishFooterText () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Load the text template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_text_start'); + /** + * Finishes the footer-class node + * + * @return void + */ + private function finishFooterClass () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * Finishes the footer-id node + * + * @return void + */ + private function finishFooterId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set its content in this template instance - $this->assignVariable('text', $this->getTemplateInstance()->getRawTemplateData()); + /** + * Finishes the anchor-href node + * + * @return void + */ + private function finishAnchorHref () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /** - * Finishes the menu text + * Finishes the anchor-title node * * @return void */ - private function finishText () { - // Load the text template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_text_end'); + private function finishAnchorTitle () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * Finishes the anchor-text node + * + * @return void + */ + private function finishAnchorText () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set its content in this template instance - $this->assignVariable('text_end', $this->getTemplateInstance()->getRawTemplateData()); + /** + * Finishes the anchor-id node + * + * @return void + */ + private function finishAnchorId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /** - * Starts the menu property 'entry' + * Finishes the anchor node * - * @param $id Id of the menu * @return void */ - private function startMenuEntry ($id) { - // Set id as current - $this->curr['entry_id'] = $id; + private function finishAnchor () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Load the entry template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_entry_' . $id . '_start'); + /** + * Finishes the entry-id node + * + * @return void + */ + private function finishEntryId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * Finishes the entry node + * + * @return void + */ + private function finishEntry () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set its content in this template instance - $this->assignVariable('entry_start_' . $this->curr['id'], $this->getTemplateInstance()->getRawTemplateData()); + /** + * Finishes the block node + * + * @return void + */ + private function finishBlock () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /** - * Finishes the entry node by added another template to the menu + * Finishes the block-list node * * @return void */ - private function finishEntry () { - // Load the entry template for this page - $this->getTemplateInstance()->loadCodeTemplate('menu_entry_' . $this->curr['entry_id'] . '_end'); + private function finishBlockList () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set the variable group to page - $this->setVariableGroup('menu'); + /** + * Finishes the menu entries + * + * @return void + */ + private function finishEntryList () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); + } - // Set its content in this template instance - $this->assignVariable('entry_end_' . $this->curr['id'], $this->getTemplateInstance()->getRawTemplateData()); + /** + * Finishes the menu block header + * + * @return void + */ + private function finishBlockHeader () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } + /** - * Starts the menu property 'anchor' + * Finishes the menu block footer * - * @param $id Id of the anchor - * @param $link Link text of the anchor - * @param $title Link title of the anchor * @return void */ - private function startMenuAnchor ($id, $link, $title) { - $this->partialStub('id='.$id.',link='.$link.',title='.$title); + private function finishBlockFooter () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /** - * Finishes the anchor node by added another template to the menu + * Finishes the menu * * @return void */ - private function finishAnchor () { - $this->partialStub('Please implement this method.'); + private function finishMenu () { + // Pop the last entry + $this->getStackerInstance()->popNamed('current_node'); } /**