X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Ftemplate%2Fobjects%2Fclass_XmlObjectRegistryTemplateEngine.php;h=15a1bb4c29e67920b7c71e7cfc7d0c6404ac1115;hb=9a1243bea20f7602ef7cdfe912a7db5ee958fba8;hp=438565cd481866c733aeac83dda70b84df11fe34;hpb=065a7d9f3cd465047a0e3ad4c41236155ff8a9d1;p=hub.git diff --git a/application/hub/main/template/objects/class_XmlObjectRegistryTemplateEngine.php b/application/hub/main/template/objects/class_XmlObjectRegistryTemplateEngine.php index 438565cd4..15a1bb4c2 100644 --- a/application/hub/main/template/objects/class_XmlObjectRegistryTemplateEngine.php +++ b/application/hub/main/template/objects/class_XmlObjectRegistryTemplateEngine.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 * @todo This template engine does not make use of setTemplateType() @@ -22,41 +22,18 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements CompileableTemplate { - /** - * Instance for the object registry - */ - private $objectRegistryInstance = null; - - /** - * Main nodes in the XML tree - */ - private $mainNodes = array( - 'object-registry' - ); - - /** - * Sub nodes in the XML tree - */ - private $subNodes = array( - 'object-list', - 'object-list-entry', - 'object-name', - 'object-recipient-limitation', - 'object-max-spread', - 'object-protocol', - 'object-recipient-type' - ); - - /** - * Current main node - */ - private $curr = array(); +class XmlObjectRegistryTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable { + // Constants + const OBJECT_TYPE_DATA_NAME = 'object-name'; + const OBJECT_TYPE_DATA_RECIPIENT_LIMITATION = 'object-recipient-limitation'; + const OBJECT_TYPE_DATA_MAX_SPREAD = 'object-max-spread'; + const OBJECT_TYPE_DATA_PROTOCOL = 'object-protocol'; + const OBJECT_TYPE_DATA_RECIPIENT_TYPE = 'object-recipient-type'; /** - * Content from dependency + * Instance for the object registry */ - private $dependencyContent = array(); + private $objectRegistryInstance = NULL; /** * Protected constructor @@ -68,13 +45,23 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp parent::__construct(__CLASS__); // Init object type registry instance - $this->objectRegistryInstance = ObjectFactory::createObjectByConfiguredName('node_object_type_registry_class'); + $this->objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance(); + + // Init sub nodes + $this->subNodes = array( + 'object-list', + 'object-list-entry', + self::OBJECT_TYPE_DATA_NAME, + self::OBJECT_TYPE_DATA_RECIPIENT_LIMITATION, + self::OBJECT_TYPE_DATA_MAX_SPREAD, + self::OBJECT_TYPE_DATA_PROTOCOL, + self::OBJECT_TYPE_DATA_RECIPIENT_TYPE + ); } /** * Creates an instance of the class TemplateEngine and prepares it for usage * - * @param $applicationInstance A manageable application * @return $templateInstance An instance of TemplateEngine * @throws BasePathIsEmptyException If the provided $templateBasePath is empty * @throws InvalidBasePathStringException If $templateBasePath is no string @@ -83,163 +70,17 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * @throws BasePathReadProtectedException If $templateBasePath is * read-protected */ - public static final function createXmlObjectRegistryTemplateEngine (ManageableApplication $applicationInstance) { + public static final function createXmlObjectRegistryTemplateEngine () { // Get a new instance $templateInstance = new XmlObjectRegistryTemplateEngine(); - // 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_object_registry_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_object_registry_stacker_class'); - - // Set it - $templateInstance->setStackerInstance($stackerInstance); + // Init template instance + $templateInstance->initXmlTemplateEngine('node', 'object_registry'); // Return the prepared instance return $templateInstance; } - /** - * Load a specified object_registry template into the engine - * - * @param $template The object_registry template we shall load which is - * located in 'object_registry' by default - * @return void - */ - public function loadObjectRegistryTemplate ($template) { - // Set template type - $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_object_registry_template_type')); - - // Load the special template - $this->loadTemplate($template); - } - - /** - * Getter for current main node - * - * @return $currMainNode Current main node - */ - public final function getCurrMainNode () { - 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; - } - - /** - * 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 - * - * @return $subNodes Array with valid sub node names - */ - public final function getSubNodes () { - return $this->subNodes; - } - - /** - * Handles the start element of an XML resource - * - * @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 = 'initObjectRegistry'; - - // 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); - } - - /** - * Ends the main or sub node by sending out the gathered data - * - * @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()); - } - /** * Currently not used * @@ -259,42 +100,18 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp } // END - if // Get current XML node name as an array index - $nodeName = $this->getStackerInstance()->getNamed('object_registry'); + $nodeName = $this->getStackerInstance()->getNamed('node_object_registry'); - // Is the node name 'object-name'? - if ($nodeName == 'object-name') { + // Is the node name self::OBJECT_TYPE_DATA_NAME? + if ($nodeName == self::OBJECT_TYPE_DATA_NAME) { // Output debug message - $this->debugOutput('TAGS: Adding object type ' . $characters . ' to registry.'); + self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __LINE__ . ']: Adding object type ' . $characters . ' to registry.'); } // END - if // Add it to the registry $this->objectRegistryInstance->addEntry($nodeName, $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 template instance - $templateInstance = ObjectFactory::createObjectByConfiguredName('node_object_registry_template_class', array($this->getApplicationInstance())); - - // Then load it - $templateInstance->loadObjectRegistryTemplate($templateDependency); - - // Parse the XML content - $templateInstance->renderXmlContent(); - - // Save the parsed raw content in our dependency array - $this->dependencyContent[$node] = $templateInstance->getRawTemplateData(); - } // END - if - } - /** * Getter for cache file (FQFN) * @@ -309,19 +126,21 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectRegistry () { + protected function startObjectRegistry () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-registry'); + $this->getStackerInstance()->pushNamed('node_object_registry', 'object-registry'); } /** * Starts the object-list * + * @param $objectCount Count of all objects * @return void + * @todo Handle $objectCount */ - private function startObjectList () { + protected function startObjectList ($objectCount) { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-list'); + $this->getStackerInstance()->pushNamed('node_object_registry', 'object-list'); } /** @@ -329,9 +148,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectListEntry () { + protected function startObjectListEntry () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-list'); + $this->getStackerInstance()->pushNamed('node_object_registry', 'object-list'); } /** @@ -339,9 +158,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectName () { + protected function startObjectName () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-name'); + $this->getStackerInstance()->pushNamed('node_object_registry', self::OBJECT_TYPE_DATA_NAME); } /** @@ -349,9 +168,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectRecipientLimitation () { + protected function startObjectRecipientLimitation () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-recipient-limitation'); + $this->getStackerInstance()->pushNamed('node_object_registry', self::OBJECT_TYPE_DATA_RECIPIENT_LIMITATION); } /** @@ -359,9 +178,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectMaxSpread () { + protected function startObjectMaxSpread () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-max-spread'); + $this->getStackerInstance()->pushNamed('node_object_registry', self::OBJECT_TYPE_DATA_MAX_SPREAD); } /** @@ -369,9 +188,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectProtocol () { + protected function startObjectProtocol () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-protocol'); + $this->getStackerInstance()->pushNamed('node_object_registry', self::OBJECT_TYPE_DATA_PROTOCOL); } /** @@ -379,9 +198,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function startObjectRecipientType () { + protected function startObjectRecipientType () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('object_registry', 'object-recipient-type'); + $this->getStackerInstance()->pushNamed('node_object_registry', self::OBJECT_TYPE_DATA_RECIPIENT_TYPE); } /** @@ -389,9 +208,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectRecipientType () { + protected function finishObjectRecipientType () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -399,9 +218,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectProtocol () { + protected function finishObjectProtocol () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -409,9 +228,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectMaxSpread () { + protected function finishObjectMaxSpread () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -419,9 +238,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectRecipientLimitation () { + protected function finishObjectRecipientLimitation () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -429,9 +248,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectName () { + protected function finishObjectName () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -439,9 +258,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectListEntry () { + protected function finishObjectListEntry () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -449,9 +268,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectList () { + protected function finishObjectList () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } /** @@ -459,9 +278,9 @@ class XmlObjectRegistryTemplateEngine extends BaseTemplateEngine implements Comp * * @return void */ - private function finishObjectRegistry () { + protected function finishObjectRegistry () { // Pop the last entry - $this->getStackerInstance()->popNamed('object_registry'); + $this->getStackerInstance()->popNamed('node_object_registry'); } }