namespace Org\Mxchange\CoreFramework\Template\Engine;
// Import framework stuff
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
use Org\Mxchange\CoreFramework\Filesystem\InvalidDirectoryException;
use Org\Mxchange\CoreFramework\Menu\RenderableMenu;
-use Org\Mxchange\CoreFramework\Parser\Xml\XmlParser;
+use Org\Mxchange\CoreFramework\Parser\Parseable;
use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
-use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
use Org\Mxchange\CoreFramework\Template\Engine\BaseTemplateEngine;
+use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
+use Org\Mxchange\CoreFramework\Traits\Stacker\StackableTrait;
+use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
// Import SPL stuff
use \SplFileInfo;
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
+ // Load traits
+ use StackableTrait;
+
/**
* Main nodes in the XML tree ('menu' is ignored)
*/
- private $mainNodes = array(
+ private $mainNodes = [
'block-list',
- );
+ ];
/**
* Sub nodes in the XML tree
*/
- private $subNodes = array(
+ private $subNodes = [
'entry-list',
'entry',
'entry-id',
'anchor-text',
'anchor-title',
'anchor-href',
- );
+ ];
/**
* Variables for a menu entry
*/
- private $menuEntryVariables = array(
+ private $menuEntryVariables = [
// List entry
'entry_id',
// Anchor
'anchor-text',
'anchor-title',
'anchor-href',
- );
+ ];
/**
* Variables for a menu block
*/
- private $menuBlockVariables = array(
+ private $menuBlockVariables = [
// Title
'title_id',
'title_class',
'footer_id',
'footer_class',
'footer_text',
- );
+ ];
/**
* Rendered menu entries
*/
- private $menuEntries = array();
+ private $menuEntries = [];
/**
* Rendered menu blocks
*/
- private $menuBlocks = array();
+ private $menuBlocks = [];
/**
- * Menu instance
+ * Current main node
*/
- private $menuInstance = NULL;
+ private $curr = [];
/**
- * Current main node
+ * Content from dependency
*/
- private $curr = array();
+ private $dependencyContent = [];
/**
- * Content from dependency
+ * Instance of a menu
*/
- private $dependencyContent = array();
+ private $menuInstance = NULL;
/**
* Protected constructor
$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
// Determine base path
- $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getAppShortName(). '/';
+ $templateBasePath = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('application_base_path') . $applicationInstance->getAppShortName(). '/';
// Is the base path valid?
if (empty($templateBasePath)) {
$templateInstance->setTemplateBasePath($templateBasePath);
// Set template extensions
- $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
- $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('menu_template_extension'));
+ $templateInstance->setRawTemplateExtension(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('raw_template_extension'));
+ $templateInstance->setCodeTemplateExtension(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('menu_template_extension'));
// Absolute output path for compiled templates
$templateInstance->setCompileOutputPath(sprintf('%s%s/',
$templateBasePath,
- $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path')
+ FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('compile_output_path')
));
// Set the menu instance
return $templateInstance;
}
+ /**
+ * Setter for the menu instance
+ *
+ * @param $menuInstance A RenderableMenu instance
+ * @return void
+ */
+ protected final function setMenuInstance (RenderableMenu $menuInstance) {
+ $this->menuInstance = $menuInstance;
+ }
+
+ /**
+ * Getter for the menu instance
+ *
+ * @return $menuInstance A RenderableMenu instance
+ */
+ private final function getMenuInstance () {
+ return $this->menuInstance;
+ }
+
/**
* Load a specified menu template into the engine
*
* located in 'menu' by default
* @return void
*/
- public function loadMenuTemplate ($template) {
+ public function loadMenuTemplate (string $template) {
// Set template type
- $this->setTemplateType($this->getConfigInstance()->getConfigEntry('menu_template_type'));
+ $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('menu_template_type'));
// Load the special template
$this->loadTemplate($template);
* @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;
+ private final function setCurrMainNode (string $element) {
+ $this->curr['main_node'] = $element;
}
/**
* @return void
* @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
*/
- public function startElement ($resource, $element, array $attributes) {
+ public function startElement ($resource, string $element, array $attributes) {
// Initial method name which will never be called...
$methodName = 'initMenu';
//* DEBUG: */ echo "START: >".$element."<<br />\n";
if (in_array($element, $this->getMainNodes())) {
// Okay, main node found!
- $methodName = 'start' . self::convertToClassName($element);
+ $methodName = 'start' . StringUtils::convertToClassName($element);
// Set it
$this->setCurrMainNode($element);
} elseif (in_array($element, $this->getSubNodes())) {
// Sub node found
- $methodName = 'start' . self::convertToClassName($element);
+ $methodName = 'start' . StringUtils::convertToClassName($element);
} elseif ($element != 'menu') {
// Invalid node name found
- throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
+ throw new InvalidXmlNodeException(array($this, $element, $attributes), Parseable::EXCEPTION_XML_NODE_UNKNOWN);
}
// Call method
* @return void
* @throws XmlNodeMismatchException If current main node mismatches the closing one
*/
- public function finishElement ($resource, $nodeName) {
- // Make all lower-case
- $nodeName = strtolower($nodeName);
-
+ public function finishElement ($resource, string $nodeName) {
// Does this match with current main node?
//* DEBUG: */ echo "END: >".$nodeName."<<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);
+ throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), Parseable::EXCEPTION_XML_NODE_MISMATCH);
} // END - if
// Construct method name
- $methodName = 'finish' . self::convertToClassName($nodeName);
+ $methodName = 'finish' . StringUtils::convertToClassName($nodeName);
// Call the corresponding method
//* DEBUG: */ echo "call: ".$methodName."<br />\n";
- call_user_func_array(array($this, $methodName), array());
+ call_user_func_array(array($this, $methodName), []);
}
/**
* @return void
* @todo Find something useful with this!
*/
- public function characterHandler ($resource, $characters) {
+ public function characterHandler ($resource, string $characters) {
// Trim all spaces away
$characters = trim($characters);
* @return void
*/
private function renderMenuEntry () {
- // Prepare template engine
- $templateInstance = $this->prepareTemplateInstance();
-
// Load menu entry template
- $templateInstance->loadCodeTemplate('menu_entry');
+ $this->getTemplateInstance()->loadCodeTemplate('menu_entry');
// Copy all variables over to it
foreach ($this->menuEntryVariables as $variableName) {
} // END - if
// ... into the instance
- $templateInstance->assignVariable($variableName, $variableValue);
+ $this->getTemplateInstance()->assignVariable($variableName, $variableValue);
} // END - foreach
// Compile template + variables
- $templateInstance->compileTemplate();
- $templateInstance->compileVariables();
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->compileVariables();
// Remember it here
- $this->menuEntries[$this->readVariable('entry_id')] = $templateInstance->getRawTemplateData();
+ $this->menuEntries[$this->readVariable('entry_id')] = $this->getTemplateInstance()->getRawTemplateData();
}
/**
// Init block content
$blockContent = implode('', $this->menuEntries);
- // Prepare template engine
- $templateInstance = $this->prepareTemplateInstance();
-
// Load menu entry template
- $templateInstance->loadCodeTemplate('menu_block');
+ $this->getTemplateInstance()->loadCodeTemplate('menu_block');
// Copy all variables over to it
foreach ($this->menuBlockVariables as $variableName) {
$variableValue = $this->readVariable($variableName);
// ... into the instance
- $templateInstance->assignVariable($variableName, $variableValue);
+ $this->getTemplateInstance()->assignVariable($variableName, $variableValue);
} // END - foreach
// Assign block content
- $templateInstance->assignVariable('block_content', $blockContent);
+ $this->getTemplateInstance()->assignVariable('block_content', $blockContent);
// Compile template + variables
- $templateInstance->compileTemplate();
- $templateInstance->compileVariables();
+ $this->getTemplateInstance()->compileTemplate();
+ $this->getTemplateInstance()->compileVariables();
// Remember it here
- array_push($this->menuBlocks, $templateInstance->getRawTemplateData());
+ array_push($this->menuBlocks, $this->getTemplateInstance()->getRawTemplateData());
// Reset rendered menu entries array
- $this->menuEntries = array();
+ $this->menuEntries = [];
}
/**
$menuContent = implode('', $this->menuBlocks);
// Clean variable
- $this->menuBlocks = array();
+ $this->menuBlocks = [];
// And return it
return $menuContent;
// Get the file instance ready
$fileInstance = new SplFileInfo(sprintf('%s%smenus/_cache/%s.%s',
- $this->getConfigInstance()->getConfigEntry('application_base_path'),
+ FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('application_base_path'),
$applicationInstance->getAppShortName(),
md5(
$this->getMenuInstance()->getMenuName() . ':' .
projects / core.git / blobdiff