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