Added sendGenericGetResponse() which sends a generic HTML GET response to the
[core.git] / inc / classes / main / commands / class_BaseCommand.php
1 <?php
2 /**
3  * A general (base) command
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
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
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class BaseCommand extends BaseFrameworkSystem {
25         /**
26          * Protected constructor
27          *
28          * @param       $className      Name of the class
29          * @return      void
30          */
31         protected function __construct ($className) {
32                 // Call parent constructor
33                 parent::__construct($className);
34         }
35
36         /**
37          * Sends a generic HTTP response with header, menu, content and footer
38          *
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          * @return      void
42          */
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());
46
47                 // Get the application instance
48                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
49
50                 // Prepare a template instance
51                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
52
53                 // Transfer application data
54                 $templateInstance->assignApplicationData($applicationInstance);
55
56                 // Load the master template
57                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
58
59                 // Load header template
60                 $templateInstance->loadCodeTemplate('header');
61
62                 // Compile and assign it with a variable
63                 $templateInstance->compileTemplate();
64                 $templateInstance->assignTemplateWithVariable('header', 'header');
65
66                 // Load footer template
67                 $templateInstance->loadCodeTemplate('footer');
68
69                 // Compile and assign it with a variable
70                 $templateInstance->compileTemplate();
71                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
72
73                 // Load the content template
74                 $templateInstance->loadCodeTemplate($this->getResolverInstance()->getCommandName());
75
76                 // Assign the content template with the master template as a content ... ;)
77                 $templateInstance->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content');
78
79                 // Load the master template
80                 $templateInstance->loadCodeTemplate($masterTemplate);
81
82                 // Set title
83                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title'));
84
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));
88
89                 // Render the menu
90                 $menuInstance->renderMenu();
91
92                 // Transfer it to the template engine instance
93                 $menuInstance->transferContentToTemplateEngine($templateInstance);
94
95                 /*
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.
99                  */
100                 $templateInstance->compileVariables();
101
102                 // Get the content back from the template engine and put it in response class
103                 $templateInstance->transferToResponse($responseInstance);
104         }
105 }
106
107 // [EOF]
108 ?>