3 namespace Org\Mxchange\CoreFramework\Command\Status;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
7 use Org\Mxchange\CoreFramework\Command\Commandable;
8 use Org\Mxchange\CoreFramework\Controller\Controller;
9 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
15 * A command for Status page
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 <<<<<<< HEAD:framework/main/classes/commands/html/class_HtmlStatusCommand.php
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
22 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
23 >>>>>>> Some updates::inc/main/classes/commands/html/class_HtmlStatusCommand.php
24 * @license GNU GPL 3.0 or any newer version
25 * @link http://www.shipsimu.org
27 * This program is free software: you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation, either version 3 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program. If not, see <http://www.gnu.org/licenses/>.
40 class HtmlStatusCommand extends BaseCommand implements Commandable {
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
52 * Creates an instance of this class
54 * @param $resolverInstance An instance of a command resolver class
55 * @return $commandInstance An instance a prepared command class
57 public static final function createHtmlStatusCommand (CommandResolver $resolverInstance) {
59 $commandInstance = new HtmlStatusCommand();
61 // Set the application instance
62 $commandInstance->setResolverInstance($resolverInstance);
64 // Return the prepared instance
65 return $commandInstance;
69 * Executes the given command with given request and response objects
71 * @param $requestInstance An instance of a class with an Requestable interface
72 * @param $responseInstance An instance of a class with an Responseable interface
76 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
77 // Get the application instance
78 $applicationInstance = Registry::getRegistry()->getInstance('app');
80 // Prepare a template instance
81 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
83 // Transfer application data
84 $templateInstance->assignApplicationData($applicationInstance);
86 // Load the master template
87 $masterTemplate = $applicationInstance->buildMasterTemplateName();
89 // Load header template
90 $templateInstance->loadCodeTemplate('header');
92 // Compile and assign it with a variable
93 $templateInstance->compileTemplate();
94 $templateInstance->assignTemplateWithVariable('header', 'header');
96 // Load footer template
97 $templateInstance->loadCodeTemplate('footer');
99 // Compile and assign it with a variable
100 $templateInstance->compileTemplate();
101 $templateInstance->assignTemplateWithVariable('footer', 'footer');
103 // Load the status template
104 $templateInstance->loadCodeTemplate('status');
106 // Assign the status template with the master template as a content ... ;)
107 $templateInstance->assignTemplateWithVariable('status', 'main_content');
109 // Load the master template
110 $templateInstance->loadCodeTemplate($masterTemplate);
113 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_status_title'));
115 // Construct the menu in every command. We could do this in BaseCommand class. But this means
116 // *every* command has a navigation system and that is want we don't want.
117 $menuInstance = ObjectFactory::createObjectByConfiguredName('status_menu_class', array($applicationInstance));
120 $menuInstance->renderMenu();
122 // Transfer it to the template engine instance
123 $menuInstance->transferContentToTemplateEngine($templateInstance);
126 * ... and all variables. This should be merged together in a pattern
127 * to make things easier. A cache mechanism should be added between
128 * these two calls to cache compiled templates.
130 $templateInstance->compileVariables();
132 // Get the content back from the template engine and put it in response class
133 $templateInstance->transferToResponse($responseInstance);
137 * Adds extra filters to the given controller instance
139 * @param $controllerInstance A controller instance
140 * @param $requestInstance An instance of a class with an Requestable interface
143 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {