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