State pattern added, hub continued (sorry, I let it lay around uncommitted for long...

[hub.git] / application / hub / main / template / announcement / class_AnnouncementTemplateEngine.php

diff --git a/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php b/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php
index 7a6dbcc0c45d6ce2cc759a2c5e7d0e1bbcbeea0f..78eb61c47a1b82ac7fe1db7d635e6fc03fe246d0 100644 (file)
--- a/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php
+++ b/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php
@@ -4,9 +4,10 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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()
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -69,7 +70,7 @@ class AnnouncementTemplateEngine extends BaseTemplateEngine implements Compileab
         * Creates an instance of the class TemplateEngine and prepares it for usage
         *
         * @param       $appInstance    A manageable application
-        * @return      $tplInstance    An instance of TemplateEngine
+        * @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
@@ -79,55 +80,55 @@ class AnnouncementTemplateEngine extends BaseTemplateEngine implements Compileab
         */
        public final static function createAnnouncementTemplateEngine (ManageableApplication $appInstance) {
                // Get a new instance
-               $tplInstance = new AnnouncementTemplateEngine();
+               $templateInstance = new AnnouncementTemplateEngine();
 
                // Get language and file I/O instances from application
                $langInstance = $appInstance->getLanguageInstance();
                $ioInstance = $appInstance->getFileIoInstance();
 
                // Determine base path
-               $templateBasePath = $tplInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
+               $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->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);
+               $templateInstance->setTemplateBasePath($templateBasePath);
 
                // Set the language and IO instances
-               $tplInstance->setLanguageInstance($langInstance);
-               $tplInstance->setFileIoInstance($ioInstance);
+               $templateInstance->setLanguageInstance($langInstance);
+               $templateInstance->setFileIoInstance($ioInstance);
 
                // Set template extensions
-               $tplInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
-               $tplInstance->setCodeTemplateExtension($configInstance->getConfigEntry('announcement_template_extension'));
+               $templateInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
+               $templateInstance->setCodeTemplateExtension($configInstance->getConfigEntry('announcement_template_extension'));
 
                // Absolute output path for compiled templates
-               $tplInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
+               $templateInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
 
                // Init a variable stacker
                $stackerInstance = ObjectFactory::createObjectByConfiguredName('announcement_stacker_class');
 
                // Set it
-               $tplInstance->setStackerInstance($stackerInstance);
+               $templateInstance->setStackerInstance($stackerInstance);
 
                // Return the prepared instance
-               return $tplInstance;
+               return $templateInstance;
        }
 
        /**