3 namespace CoreFramework\Command\Guest;
5 // Import framework stuff
6 use CoreFramework\Command\BaseCommand;
7 use CoreFramework\Command\Commandable;
8 use CoreFranework\Controller\Controller;
9 use CoreFramework\Factory\ObjectFactory;
10 use CoreFramework\Request\Requestable;
11 use CoreFramework\Resolver\Command\CommandResolver;
12 use CoreFramework\Response\Responseable;
15 * A command for the home page
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class HtmlHomeCommand extends BaseCommand implements Commandable {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
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 static final function createHtmlHomeCommand (CommandResolver $resolverInstance) {
55 $commandInstance = new HtmlHomeCommand();
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 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
75 // Prepare a template instance
76 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
78 // Transfer application data
79 $templateInstance->assignApplicationData($applicationInstance);
81 // Load the master template
82 $masterTemplate = $applicationInstance->buildMasterTemplateName();
84 // Load header template
85 $templateInstance->loadCodeTemplate('header');
87 // Compile and assign it with a variable
88 $templateInstance->compileTemplate();
89 $templateInstance->assignTemplateWithVariable('header', 'header');
91 // Load footer template
92 $templateInstance->loadCodeTemplate('footer');
94 // Compile and assign it with a variable
95 $templateInstance->compileTemplate();
96 $templateInstance->assignTemplateWithVariable('footer', 'footer');
98 // Load the home template
99 $templateInstance->loadCodeTemplate('home');
101 // Assign the home template with the master template as a content ... ;)
102 $templateInstance->assignTemplateWithVariable('home', 'main_content');
104 // Load the master template
105 $templateInstance->loadCodeTemplate($masterTemplate);
108 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_home_title'));
110 // Construct the menu in every command. We could do this in BaseCommand class. But this means
111 // *every* command has a navigation system and that is want we don't want.
112 $menuInstance = ObjectFactory::createObjectByConfiguredName('home_menu_class', array($applicationInstance));
115 $menuInstance->renderMenu();
117 // Transfer it to the template engine instance
118 $menuInstance->transferContentToTemplateEngine($templateInstance);
121 * ... and all variables. This should be merged together in a pattern
122 * to make things easier. A cache mechanism should be added between
123 * these two calls to cache compiled templates.
125 $templateInstance->compileVariables();
127 // Get the content back from the template engine and put it in response class
128 $templateInstance->transferToResponse($responseInstance);
132 * Adds extra filters to the given controller instance
134 * @param $controllerInstance A controller instance
135 * @param $requestInstance An instance of a class with an Requestable interface
138 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {