3 namespace CoreFramework\Command;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Object\BaseFrameworkSystem;
8 use CoreFramework\Request\Requestable;
9 use CoreFramework\Response\Responseable;
12 * A general (base) command
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class BaseCommand extends BaseFrameworkSystem {
35 * Protected constructor
37 * @param $className Name of the class
40 protected function __construct ($className) {
41 // Call parent constructor
42 parent::__construct($className);
46 * Sends a generic HTTP response with header, menu, content and footer
48 * @param $requestInstance An instance of a class with an Requestable interface
49 * @param $responseInstance An instance of a class with an Responseable interface
50 * @param $suffix Optional template suffix, e.g. '_form' for forms
53 protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, $suffix = '') {
54 // This command doesn't handle any POST requests, so only handle get request
55 assert(!$requestInstance->isPostRequestMethod());
57 // Get the application instance
58 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
60 // Prepare a template instance
61 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
63 // Transfer application data
64 $templateInstance->assignApplicationData($applicationInstance);
67 $templateInstance->assignConfigVariable('base_url');
69 // Load the master template
70 $masterTemplate = $applicationInstance->buildMasterTemplateName();
72 // Load header template
73 $templateInstance->loadCodeTemplate('header');
75 // Compile and assign it with a variable
76 $templateInstance->compileTemplate();
77 $templateInstance->assignTemplateWithVariable('header', 'header');
79 // Load footer template
80 $templateInstance->loadCodeTemplate('footer');
82 // Compile and assign it with a variable
83 $templateInstance->compileTemplate();
84 $templateInstance->assignTemplateWithVariable('footer', 'footer');
86 // Load the content template
87 $templateInstance->loadCodeTemplate($this->getResolverInstance()->getCommandName() . $suffix);
89 // Assign the content template with the master template as a content ... ;)
90 $templateInstance->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content');
92 // Load the master template
93 $templateInstance->loadCodeTemplate($masterTemplate);
96 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title'));
98 // Construct the menu in every command. We could do this in BaseCommand class. But this means
99 // *every* command has a navigation system and that is want we don't want.
100 $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class', array($applicationInstance));
103 $menuInstance->renderMenu();
105 // Transfer it to the template engine instance
106 $menuInstance->transferContentToTemplateEngine($templateInstance);
109 * ... and all variables. This should be merged together in a pattern
110 * to make things easier. A cache mechanism should be added between
111 * these two calls to cache compiled templates.
113 $templateInstance->compileVariables();
115 // Get the content back from the template engine and put it in response class
116 $templateInstance->transferToResponse($responseInstance);