inc/classes/main/commands/web/class_WebHomeCommand.php

   1 <?php
   2 /**
   3  * A command for the "home" page
   4  *
   5  * @author              Roland Haeder <webmaster@mxchange.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class WebHomeCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set special description
  35                 $this->setObjectDescription("Command for the &quot;home&quot; page");
  36
  37                 // Create unique ID number
  38                 $this->createUniqueID();
  39
  40                 // Clean up a little
  41                 $this->removeSystemArray();
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @param       $resolverInstance               An instance of a command resolver class
  48          * @return      $commandInstance                An instance a prepared command class
  49          */
  50         public final static function createWebHomeCommand (CommandResolver $resolverInstance) {
  51                 // Get new instance
  52                 $commandInstance = new WebHomeCommand();
  53
  54                 // Set the application instance
  55                 $commandInstance->setResolverInstance($resolverInstance);
  56
  57                 // Return the prepared instance
  58                 return $commandInstance;
  59         }
  60
  61         /**
  62          * Executes the given command with given request and response objects
  63          *
  64          * @param       $requestInstance                An instance of a class with an Requestable interface
  65          * @param       $responseInstance               An instance of a class with an Responseable interface
  66          * @return      void
  67          */
  68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Get the application instance
  70                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
  71
  72                 // Prepare a template instance
  73                 $templateInstance = $this->prepareTemplateEngine($appInstance);
  74
  75                 // Load the master template
  76                 $masterTemplate = $appInstance->getMasterTemplate();
  77
  78                 // Load header template
  79                 $templateInstance->loadCodeTemplate("header");
  80
  81                 // Compile and assign it with a variable
  82                 $templateInstance->compileTemplate();
  83                 $templateInstance->assignTemplateWithVariable("header", "header");
  84
  85                 // Load footer template
  86                 $templateInstance->loadCodeTemplate("footer");
  87
  88                 // Compile and assign it with a variable
  89                 $templateInstance->compileTemplate();
  90                 $templateInstance->assignTemplateWithVariable("footer", "footer");
  91
  92                 // Load the home template
  93                 $templateInstance->loadCodeTemplate("home");
  94
  95                 // Assign the home template with the master template as a content ... ;)
  96                 $templateInstance->assignTemplateWithVariable("home", "content");
  97
  98                 // Load the master template
  99                 $templateInstance->loadCodeTemplate($masterTemplate);
 100
 101                 // Set title
 102                 $title = ucfirst($requestInstance->getRequestElement($this->getConfigInstance()->readConfig('command_parameter')));
 103                 if (empty($title)) $title = "Home";
 104                 $templateInstance->assignVariable('title', $title);
 105
 106                 // ... and all variables. This should be merged together in a pattern
 107                 // to make things easier. A cache mechanism should be added between
 108                 // these two calls to cache compiled templates.
 109                 $templateInstance->compileVariables();
 110
 111                 // Get the content back from the template engine and put it in the response class
 112                 $templateInstance->transferToResponse($responseInstance);
 113         }
 114 }
 115
 116 // [EOF]
 117 ?>