3 * A general (base) command
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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
43 protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance) {
44 // This command doesn't handle any POST requests, so only handle get request
45 assert(!$requestInstance->isPostRequestMethod());
47 // Get the application instance
48 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
50 // Prepare a template instance
51 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
53 // Transfer application data
54 $templateInstance->assignApplicationData($applicationInstance);
56 // Load the master template
57 $masterTemplate = $applicationInstance->buildMasterTemplateName();
59 // Load header template
60 $templateInstance->loadCodeTemplate('header');
62 // Compile and assign it with a variable
63 $templateInstance->compileTemplate();
64 $templateInstance->assignTemplateWithVariable('header', 'header');
66 // Load footer template
67 $templateInstance->loadCodeTemplate('footer');
69 // Compile and assign it with a variable
70 $templateInstance->compileTemplate();
71 $templateInstance->assignTemplateWithVariable('footer', 'footer');
73 // Load the content template
74 $templateInstance->loadCodeTemplate($this->getResolverInstance()->getCommandName());
76 // Assign the content template with the master template as a content ... ;)
77 $templateInstance->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content');
79 // Load the master template
80 $templateInstance->loadCodeTemplate($masterTemplate);
83 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title'));
85 // Construct the menu in every command. We could do this in BaseCommand class. But this means
86 // *every* command has a navigation system and that is want we don't want.
87 $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class', array($applicationInstance));
90 $menuInstance->renderMenu();
92 // Transfer it to the template engine instance
93 $menuInstance->transferContentToTemplateEngine($templateInstance);
96 * ... and all variables. This should be merged together in a pattern
97 * to make things easier. A cache mechanism should be added between
98 * these two calls to cache compiled templates.
100 $templateInstance->compileVariables();
102 // Get the content back from the template engine and put it in response class
103 $templateInstance->transferToResponse($responseInstance);