]> git.mxchange.org Git - core.git/blob - framework/main/classes/commands/html/class_HtmlStatusCommand.php
Continued:
[core.git] / framework / main / classes / commands / html / class_HtmlStatusCommand.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Command\Status;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Command\BaseCommand;
8 use Org\Mxchange\CoreFramework\Command\Commandable;
9 use Org\Mxchange\CoreFramework\Controller\Controller;
10 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
11 use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
12 use Org\Mxchange\CoreFramework\Request\Requestable;
13 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
14 use Org\Mxchange\CoreFramework\Response\Responseable;
15
16 /**
17  * A command for Status page
18  *
19  * @author              Roland Haeder <webmaster@shipsimu.org>
20  * @version             0.0.0
21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
22  * @license             GNU GPL 3.0 or any newer version
23  * @link                http://www.shipsimu.org
24  *
25  * This program is free software: you can redistribute it and/or modify
26  * it under the terms of the GNU General Public License as published by
27  * the Free Software Foundation, either version 3 of the License, or
28  * (at your option) any later version.
29  *
30  * This program is distributed in the hope that it will be useful,
31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33  * GNU General Public License for more details.
34  *
35  * You should have received a copy of the GNU General Public License
36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
37  */
38 class HtmlStatusCommand extends BaseCommand implements Commandable {
39         /**
40          * Protected constructor
41          *
42          * @return      void
43          */
44         private function __construct () {
45                 // Call parent constructor
46                 parent::__construct(__CLASS__);
47         }
48
49         /**
50          * Creates an instance of this class
51          *
52          * @param       $resolverInstance       An instance of a command resolver class
53          * @return      $commandInstance        An instance a prepared command class
54          */
55         public static final function createHtmlStatusCommand (CommandResolver $resolverInstance) {
56                 // Get new instance
57                 $commandInstance = new HtmlStatusCommand();
58
59                 // Set the application instance
60                 $commandInstance->setResolverInstance($resolverInstance);
61
62                 // Return the prepared instance
63                 return $commandInstance;
64         }
65
66         /**
67          * Executes the given command with given request and response objects
68          *
69          * @param       $requestInstance        An instance of a class with an Requestable interface
70          * @param       $responseInstance       An instance of a class with an Responseable interface
71          * @return      void
72          * @todo        0% done
73          */
74         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
75                 // Get the application instance
76                 $applicationInstance = ApplicationHelper::getSelfInstance();
77
78                 // Transfer application data
79                 $this->getTemplateInstance()->assignApplicationData();
80
81                 // Load the master template
82                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
83
84                 // Load header template
85                 $this->getTemplateInstance()->loadCodeTemplate('header');
86
87                 // Compile and assign it with a variable
88                 $this->getTemplateInstance()->compileTemplate();
89                 $this->getTemplateInstance()->assignTemplateWithVariable('header', 'header');
90
91                 // Load footer template
92                 $this->getTemplateInstance()->loadCodeTemplate('footer');
93
94                 // Compile and assign it with a variable
95                 $this->getTemplateInstance()->compileTemplate();
96                 $this->getTemplateInstance()->assignTemplateWithVariable('footer', 'footer');
97
98                 // Load the status template
99                 $this->getTemplateInstance()->loadCodeTemplate('status');
100
101                 // Assign the status template with the master template as a content ... ;)
102                 $this->getTemplateInstance()->assignTemplateWithVariable('status', 'main_content');
103
104                 // Load the master template
105                 $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
106
107                 // Set title
108                 $this->getTemplateInstance()->assignVariable('title', FrameworkBootstrap::getLanguageInstance()->getMessage('page_status_title'));
109
110                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
111                 // *every* command has a navigation system and that is want we don't want.
112                 $menuInstance = ObjectFactory::createObjectByConfiguredName('status_menu_class');
113
114                 // Render the menu
115                 $menuInstance->renderMenu();
116
117                 // Transfer it to the template engine instance
118                 $menuInstance->transferContentToTemplateEngine($this->getTemplateInstance());
119
120                 /*
121                  * ... and all variables. This should be merged together in a pattern
122                  * to make things easier. A cache mechanism should be added between
123                  * these two calls to cache compiled templates.
124                  */
125                 $this->getTemplateInstance()->compileVariables();
126
127                 // Get the content back from the template engine and put it in response class
128                 $this->getTemplateInstance()->transferToResponse($responseInstance);
129         }
130
131         /**
132          * Adds extra filters to the given controller instance
133          *
134          * @param       $controllerInstance             A controller instance
135          * @param       $requestInstance                An instance of a class with an Requestable interface
136          * @return      void
137          */
138         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
139                 // Empty for now
140         }
141
142 }