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