Code syncronized with shipsimu code base

[mailer.git] / inc / classes / main / commands / web / class_WebHomeCommand.php

diff --git a/inc/classes/main/commands/web/class_WebHomeCommand.php b/inc/classes/main/commands/web/class_WebHomeCommand.php
index 3cc3592cf40c022d46a85f709c1c0dbad2ef774a..14a7a9c6ff69029d31875c0b292b043753500d7c 100644 (file)
--- a/inc/classes/main/commands/web/class_WebHomeCommand.php
+++ b/inc/classes/main/commands/web/class_WebHomeCommand.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * A command for the "home" page
+ * A command for the home page
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -30,22 +30,13 @@ class WebHomeCommand extends BaseCommand implements Commandable {
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Set special description
-               $this->setObjectDescription("Command for the &quot;home&quot; page");
-
-               // Create unique ID number
-               $this->generateUniqueId();
-
-               // Clean up a little
-               $this->removeSystemArray();
        }
 
        /**
         * Creates an instance of this class
         *
-        * @param       $resolverInstance               An instance of a command resolver class
-        * @return      $commandInstance                An instance a prepared command class
+        * @param       $resolverInstance       An instance of a command resolver class
+        * @return      $commandInstance        An instance a prepared command class
         */
        public final static function createWebHomeCommand (CommandResolver $resolverInstance) {
                // Get new instance
@@ -61,8 +52,8 @@ class WebHomeCommand extends BaseCommand implements Commandable {
        /**
         * Executes the given command with given request and response objects
         *
-        * @param       $requestInstance                An instance of a class with an Requestable interface
-        * @param       $responseInstance               An instance of a class with an Responseable interface
+        * @param       $requestInstance        An instance of a class with an Requestable interface
+        * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
@@ -70,38 +61,39 @@ class WebHomeCommand extends BaseCommand implements Commandable {
                $appInstance = $this->getResolverInstance()->getApplicationInstance();
 
                // Prepare a template instance
-               $templateInstance = $this->prepareTemplateEngine($appInstance);
+               $templateInstance = $this->prepareTemplateInstance($appInstance);
+
+               // Transfer application data
+               $templateInstance->assignApplicationData($appInstance);
 
                // Load the master template
                $masterTemplate = $appInstance->getMasterTemplate();
 
                // Load header template
-               $templateInstance->loadCodeTemplate("header");
+               $templateInstance->loadCodeTemplate('header');
 
                // Compile and assign it with a variable
                $templateInstance->compileTemplate();
-               $templateInstance->assignTemplateWithVariable("header", "header");
+               $templateInstance->assignTemplateWithVariable('header', 'header');
 
                // Load footer template
-               $templateInstance->loadCodeTemplate("footer");
+               $templateInstance->loadCodeTemplate('footer');
 
                // Compile and assign it with a variable
                $templateInstance->compileTemplate();
-               $templateInstance->assignTemplateWithVariable("footer", "footer");
+               $templateInstance->assignTemplateWithVariable('footer', 'footer');
 
                // Load the home template
-               $templateInstance->loadCodeTemplate("home");
+               $templateInstance->loadCodeTemplate('home');
 
                // Assign the home template with the master template as a content ... ;)
-               $templateInstance->assignTemplateWithVariable("home", "content");
+               $templateInstance->assignTemplateWithVariable('home', 'content');
 
                // Load the master template
                $templateInstance->loadCodeTemplate($masterTemplate);
 
                // Set title
-               $title = ucfirst($requestInstance->getRequestElement("page"));
-               if (empty($title)) $title = "Home";
-               $templateInstance->assignVariable('title', $title);
+               $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_home_title'));
 
                // ... and all variables. This should be merged together in a pattern
                // to make things easier. A cache mechanism should be added between
@@ -111,6 +103,17 @@ class WebHomeCommand extends BaseCommand implements Commandable {
                // Get the content back from the template engine and put it in the response class
                $templateInstance->transferToResponse($responseInstance);
        }
+
+       /**
+        * Adds extra filters to the given controller instance
+        *
+        * @param       $controllerInstance             A controller instance
+        * @param       $requestInstance                An instance of a class with an Requestable interface
+        * @return      void
+        */
+       public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
+               // Empty for now
+       }
 }
 
 // [EOF]