3 * A command for the "home" page
5 * @author Roland Haeder <webmaster@ship-simu.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 WebHomeCommand extends BaseCommand implements Commandable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set special description
35 $this->setObjectDescription("Command for the "home" page");
37 // Create unique ID number
38 $this->generateUniqueId();
41 $this->removeSystemArray();
45 * Creates an instance of this class
47 * @param $resolverInstance An instance of a command resolver class
48 * @return $commandInstance An instance a prepared command class
50 public final static function createWebHomeCommand (CommandResolver $resolverInstance) {
52 $commandInstance = new WebHomeCommand();
54 // Set the application instance
55 $commandInstance->setResolverInstance($resolverInstance);
57 // Return the prepared instance
58 return $commandInstance;
62 * Executes the given command with given request and response objects
64 * @param $requestInstance An instance of a class with an Requestable interface
65 * @param $responseInstance An instance of a class with an Responseable interface
68 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
69 // Get the application instance
70 $appInstance = $this->getResolverInstance()->getApplicationInstance();
72 // Prepare a template instance
73 $templateInstance = $this->prepareTemplateEngine($appInstance);
75 // Load the master template
76 $masterTemplate = $appInstance->getMasterTemplate();
78 // Load header template
79 $templateInstance->loadCodeTemplate("header");
81 // Compile and assign it with a variable
82 $templateInstance->compileTemplate();
83 $templateInstance->assignTemplateWithVariable("header", "header");
85 // Load footer template
86 $templateInstance->loadCodeTemplate("footer");
88 // Compile and assign it with a variable
89 $templateInstance->compileTemplate();
90 $templateInstance->assignTemplateWithVariable("footer", "footer");
92 // Load the home template
93 $templateInstance->loadCodeTemplate("home");
95 // Assign the home template with the master template as a content ... ;)
96 $templateInstance->assignTemplateWithVariable("home", "content");
98 // Load the master template
99 $templateInstance->loadCodeTemplate($masterTemplate);
102 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_home_title'));
104 // ... and all variables. This should be merged together in a pattern
105 // to make things easier. A cache mechanism should be added between
106 // these two calls to cache compiled templates.
107 $templateInstance->compileVariables();
109 // Get the content back from the template engine and put it in the response class
110 $templateInstance->transferToResponse($responseInstance);
114 * Adds extra filters to the given controller instance
116 * @param $controllerInstance A controller instance
117 * @param $requestInstance An instance of a class with an Requestable interface
120 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {