3 * A command for the "home" page
5 * @author Roland Haeder <webmaster@mxchange.org>
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
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.
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.
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/>.
24 class LocalHomeCommand extends BaseCommand implements Commandable {
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set special description
35 $this->setObjectDescription("Home-Command");
37 // Create unique ID number
38 $this->createUniqueID();
41 $this->removeSystemArray();
43 // Set assigned controller
44 $this->setControllerName("default");
48 * Creates an instance of this class
50 * @param $resolverInstance An instance of a command resolver class
51 * @return $commandInstance An instance a prepared command class
53 public final static function createLocalHomeCommand (CommandResolver $resolverInstance) {
55 $commandInstance = new LocalHomeCommand();
57 // Set the application instance
58 $commandInstance->setResolverInstance($resolverInstance);
60 // Return the prepared instance
61 return $commandInstance;
65 * Executes the given command with given request and response objects
67 * @param $requestInstance An instance of a class with an Requestable interface
68 * @param $responseInstance An instance of a class with an Responseable interface
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 // Get the application instance
73 $appInstance = $this->getResolverInstance()->getApplicationInstance();
75 // Prepare a template instance
76 $templateInstance = $this->prepareTemplateEngine($appInstance);
78 // Load the master template
79 $masterTemplate = $appInstance->getMasterTemplate();
81 // Load the home template
82 $templateInstance->loadWebTemplate("home");
84 // Assign the home template with the master template as a content ... ;)
85 $templateInstance->assignTemplateWithVariable("home", "content");
87 // Load the master template
88 $templateInstance->loadCodeTemplate($masterTemplate);
91 $templateInstance->compileTemplate();
94 $title = ucfirst($requestInstance->getRequestElement($this->getConfigInstance()->readConfig("command_parameter")));
95 if (empty($title)) $title = "Home";
96 $templateInstance->assignVariable("title", $title);
98 // ... and all variables. This should be merged together in a pattern
99 // to make things easier. A cache mechanism should be added between
100 // these two calls to cache compiled templates.
101 $templateInstance->compileVariables();
103 // Get the content back from the template engine and put it in the response class
104 $templateInstance->transferToResponse($responseInstance);