3 * A general (base) command
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 BaseCommand extends BaseFrameworkSystem {
26 * Protected constructor
28 * @param $className Name of the class
31 protected function __construct ($className) {
32 // Call parent constructor
33 parent::__construct($className);
37 * Sends a generic HTTP response with header, menu, content and footer
39 * @param $requestInstance An instance of a class with an Requestable interface
40 * @param $responseInstance An instance of a class with an Responseable interface
41 * @param $suffix Optional template suffix, e.g. '_form' for forms
44 protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, $suffix = '') {
45 // This command doesn't handle any POST requests, so only handle get request
46 assert(!$requestInstance->isPostRequestMethod());
48 // Get the application instance
49 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
51 // Prepare a template instance
52 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
54 // Transfer application data
55 $templateInstance->assignApplicationData($applicationInstance);
58 $templateInstance->assignConfigVariable('base_url');
60 // Load the master template
61 $masterTemplate = $applicationInstance->buildMasterTemplateName();
63 // Load header template
64 $templateInstance->loadCodeTemplate('header');
66 // Compile and assign it with a variable
67 $templateInstance->compileTemplate();
68 $templateInstance->assignTemplateWithVariable('header', 'header');
70 // Load footer template
71 $templateInstance->loadCodeTemplate('footer');
73 // Compile and assign it with a variable
74 $templateInstance->compileTemplate();
75 $templateInstance->assignTemplateWithVariable('footer', 'footer');
77 // Load the content template
78 $templateInstance->loadCodeTemplate($this->getResolverInstance()->getCommandName() . $suffix);
80 // Assign the content template with the master template as a content ... ;)
81 $templateInstance->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content');
83 // Load the master template
84 $templateInstance->loadCodeTemplate($masterTemplate);
87 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title'));
89 // Construct the menu in every command. We could do this in BaseCommand class. But this means
90 // *every* command has a navigation system and that is want we don't want.
91 $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class', array($applicationInstance));
94 $menuInstance->renderMenu();
96 // Transfer it to the template engine instance
97 $menuInstance->transferContentToTemplateEngine($templateInstance);
100 * ... and all variables. This should be merged together in a pattern
101 * to make things easier. A cache mechanism should be added between
102 * these two calls to cache compiled templates.
104 $templateInstance->compileVariables();
106 // Get the content back from the template engine and put it in response class
107 $templateInstance->transferToResponse($responseInstance);