3 namespace CoreFramework\Command\Status;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Request\Requestable;
8 use CoreFramework\Response\Responseable;
11 * A command for Status page
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class HtmlStatusCommand extends BaseCommand implements Commandable {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this class
46 * @param $resolverInstance An instance of a command resolver class
47 * @return $commandInstance An instance a prepared command class
49 public static final function createHtmlStatusCommand (CommandResolver $resolverInstance) {
51 $commandInstance = new HtmlStatusCommand();
53 // Set the application instance
54 $commandInstance->setResolverInstance($resolverInstance);
56 // Return the prepared instance
57 return $commandInstance;
61 * Executes the given command with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @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 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
72 // Prepare a template instance
73 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
75 // Transfer application data
76 $templateInstance->assignApplicationData($applicationInstance);
78 // Load the master template
79 $masterTemplate = $applicationInstance->buildMasterTemplateName();
81 // Load header template
82 $templateInstance->loadCodeTemplate('header');
84 // Compile and assign it with a variable
85 $templateInstance->compileTemplate();
86 $templateInstance->assignTemplateWithVariable('header', 'header');
88 // Load footer template
89 $templateInstance->loadCodeTemplate('footer');
91 // Compile and assign it with a variable
92 $templateInstance->compileTemplate();
93 $templateInstance->assignTemplateWithVariable('footer', 'footer');
95 // Load the status template
96 $templateInstance->loadCodeTemplate('status');
98 // Assign the status template with the master template as a content ... ;)
99 $templateInstance->assignTemplateWithVariable('status', 'main_content');
101 // Load the master template
102 $templateInstance->loadCodeTemplate($masterTemplate);
105 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_status_title'));
107 // Construct the menu in every command. We could do this in BaseCommand class. But this means
108 // *every* command has a navigation system and that is want we don't want.
109 $menuInstance = ObjectFactory::createObjectByConfiguredName('status_menu_class', array($applicationInstance));
112 $menuInstance->renderMenu();
114 // Transfer it to the template engine instance
115 $menuInstance->transferContentToTemplateEngine($templateInstance);
118 * ... and all variables. This should be merged together in a pattern
119 * to make things easier. A cache mechanism should be added between
120 * these two calls to cache compiled templates.
122 $templateInstance->compileVariables();
124 // Get the content back from the template engine and put it in response class
125 $templateInstance->transferToResponse($responseInstance);
129 * Adds extra filters to the given controller instance
131 * @param $controllerInstance A controller instance
132 * @param $requestInstance An instance of a class with an Requestable interface
135 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {