* 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',
);
/**
/**
* Current main node
*/
- private $currMainNode = '';
+ private $curr = array();
+
+ /**
+ * Content from dependency
+ */
+ private $dependencyContent = array();
/**
* Protected constructor
* @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;
}
/**
//* DEBUG: */ echo "START: >".$element."<<br />\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);
// Call the corresponding method
//* DEBUG: */ echo "call: ".$methodName."<br />\n";
- call_user_func_array(array($this->getMenuInstance(), $methodName), array());
+ call_user_func_array(array($this, $methodName), array());
}
/**
} // END - if
// Unfinished work!
- $this->partialStub("Handling extra characters is not yet supported!");
+ $this->partialStub('Handling extra characters is not yet supported! length='.strlen($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->getApplicationInstance(), $this->getMenuInstance()));
+
+ // Then load it
+ $templateInstance->loadMenuTemplate($templateDependency);
+
+ // Get an XmlParser instance
+ $templateInstance->renderXmlContent();
+
+ // Parse the template's content contents
+ $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!
+ 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);
+
+ // Load the header template for this page
+ $this->getTemplateInstance()->loadCodeTemplate('menu_global_start');
+
+ // Set the variable group to page
+ $this->setVariableGroup('menu');
+
+ // Set its content in this template instance
+ $this->assignVariable('menu_start', $this->getTemplateInstance()->getRawTemplateData());
+ }
+
+ /**
+ * Finishes the menu
+ *
+ * @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());
+ }
+
+ /**
+ * Starts the menu entries by loading a (maybe) provided template dependency
+ *
+ * @param $templateDependency A template to load to satisfy dependencies
+ * @return void
+ */
+ private function startEntryList ($templateDependency = '') {
+ // Handle the dependency template
+ $this->handleTemplateDependency('entries', $templateDependency);
+
+ // 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());
+ }
+
+ /**
+ * Finishes the menu entries
+ *
+ * @return void
+ */
+ private function finishEntryList () {
+ // 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());
+ }
+
+ /**
+ * Starts the menu block header
+ *
+ * @return void
+ */
+ private function startBlockHeader () {
+ // 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());
+ }
+
+ /**
+ * Finishes the menu block header
+ *
+ * @return void
+ */
+ private function finishBlockHeader () {
+ // Load the header template for this page
+ $this->getTemplateInstance()->loadCodeTemplate('menu_header_end');
+
+ // Set the variable group to page
+ $this->setVariableGroup('menu');
+
+ // Set its content in this template instance
+ $this->assignVariable('header_end', $this->getTemplateInstance()->getRawTemplateData());
+ }
+
+ /**
+ * Starts the menu block footer
+ *
+ * @return void
+ */
+ private function startBlockFooter () {
+ // 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 footer template for this page
+ $this->getTemplateInstance()->loadCodeTemplate('menu_footer_start');
+
+ // Set the variable group to page
+ $this->setVariableGroup('menu');
+
+ // Set its content in this template instance
+ $this->assignVariable('footer', $this->getTemplateInstance()->getRawTemplateData());
+ }
+
+ /**
+ * Finishes the menu block footer
+ *
+ * @return void
+ */
+ private function finishBlockFooter () {
+ // Load the footer template for this page
+ $this->getTemplateInstance()->loadCodeTemplate('menu_footer_end');
+
+ // Set the variable group to page
+ $this->setVariableGroup('menu');
+
+ // Set its content in this template instance
+ $this->assignVariable('footer_end', $this->getTemplateInstance()->getRawTemplateData());
+ }
+
+ /**
+ * Starts the menu property 'title'
+ *
+ * @return void
+ */
+ private function startTitle () {
+ $this->partialStub('Cleared due to XML rewrite.');
+ }
+
+ /**
+ * Finishes the title node by added another template to the menu
+ *
+ * @return void
+ */
+ private function finishTitle () {
+ $this->partialStub('Cleared due to XML rewrite.');
+ }
+
+ /**
+ * Starts the menu text
+ *
+ * @return void
+ */
+ private function startText () {
+ // 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 text template for this page
+ $this->getTemplateInstance()->loadCodeTemplate('menu_text_start');
+
+ // Set the variable group to page
+ $this->setVariableGroup('menu');
+
+ // Set its content in this template instance
+ $this->assignVariable('text', $this->getTemplateInstance()->getRawTemplateData());
+ }
+
+ /**
+ * Finishes the menu text
+ *
+ * @return void
+ */
+ private function finishText () {
+ // Load the text template for this page
+ $this->getTemplateInstance()->loadCodeTemplate('menu_text_end');
+
+ // Set the variable group to page
+ $this->setVariableGroup('menu');
+
+ // Set its content in this template instance
+ $this->assignVariable('text_end', $this->getTemplateInstance()->getRawTemplateData());
+ }
+
+ /**
+ * Starts the menu property 'entry'
+ *
+ * @return void
+ */
+ private function startEntry () {
+ $this->partialStub('Cleared due to XML rewrite.');
+ }
+
+ /**
+ * Finishes the entry node by added another template to the menu
+ *
+ * @return void
+ */
+ private function finishEntry () {
+ $this->partialStub('Cleared due to XML rewrite.');
+ }
+
+ /**
+ * Starts the menu property 'anchor'
+ *
+ * @param $id Id of the anchor
+ * @param $link Link text of the anchor
+ * @param $title Link title of the anchor
+ * @return void
+ */
+ private function startAnchor () {
+ $this->partialStub('Please implement this method.');
+ }
+
+ /**
+ * Finishes the anchor node by added another template to the menu
+ *
+ * @return void
+ */
+ private function finishAnchor () {
$this->partialStub('Please implement this method.');
}
$this->getGenericBasePath(),
'menus/_cache',
md5(
- $this->getMenuInstance()->getMenuName() . ':' . $this->__toString() . ':' . $this->getMenuInstance()->__toString()
+ $this->getMenuInstance()->getMenuName() . ':' .
+ $this->__toString() . ':' .
+ $this->getMenuInstance()->__toString()
),
$this->getMenuInstance()->getMenuType()
);