]> 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\Factory\ObjectFactory;
7 use CoreFramework\Registry\Registerable;
8 use CoreFramework\Registry\Generic\Registry;
9 use CoreFramework\Request\Requestable;
10 use CoreFramework\Response\Responseable;
11
12 /**
13  * A command class for the registration form
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 class HtmlRegisterCommand extends BaseCommand implements Commandable, Registerable {
35         /**
36          * Protected constructor
37          *
38          * @return      void
39          */
40         protected function __construct () {
41                 // Call parent constructor
42                 parent::__construct(__CLASS__);
43         }
44
45         /**
46          * Creates an instance of this class
47          *
48          * @param       $resolverInstance       An instance of a command resolver class
49          * @return      $commandInstance        An instance a prepared command class
50          */
51         public static final function createHtmlRegisterCommand (CommandResolver $resolverInstance) {
52                 // Get new instance
53                 $commandInstance = new HtmlRegisterCommand();
54
55                 // Set the application instance
56                 $commandInstance->setResolverInstance($resolverInstance);
57
58                 // Return the prepared instance
59                 return $commandInstance;
60         }
61
62         /**
63          * Executes the given command with given request and response objects
64          *
65          * @param       $requestInstance        An instance of a class with an Requestable interface
66          * @param       $responseInstance       An instance of a class with an Responseable interface
67          * @return      void
68          */
69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
70                 // Set request instance as extra instance
71                 Registry::getRegistry()->addInstance('extra', $this);
72
73                 // Get the application instance
74                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
75
76                 // Prepare a template instance
77                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
78
79                 // Assign all the application's data with template variables
80                 $templateInstance->assignApplicationData($applicationInstance);
81
82                 // Assign base URL
83                 $templateInstance->assignConfigVariable('base_url');
84
85                 // Load the master template
86                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
87
88                 // Load header template
89                 $templateInstance->loadCodeTemplate('header');
90
91                 // Compile and assign it with a variable
92                 $templateInstance->compileTemplate();
93                 $templateInstance->assignTemplateWithVariable('header', 'header');
94
95                 // Load footer template
96                 $templateInstance->loadCodeTemplate('footer');
97
98                 // Compile and assign it with a variable
99                 $templateInstance->compileTemplate();
100                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
101
102                 // Load the register template
103                 $templateInstance->loadCodeTemplate('register_form');
104
105                 // Assign the register template with the master template as a content ... ;)
106                 $templateInstance->compileTemplate();
107                 $templateInstance->assignTemplateWithVariable('register_form', 'main_content');
108
109                 // Load the master template
110                 $templateInstance->loadCodeTemplate($masterTemplate);
111
112                 // Set title
113                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_register_title'));
114
115                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
116                 // *every* command has a navigation system and that is want we don't want.
117                 $menuInstance = ObjectFactory::createObjectByConfiguredName('register_menu_class', array($applicationInstance));
118
119                 // Render the menu
120                 $menuInstance->renderMenu();
121
122                 // Transfer it to the template engine instance
123                 $menuInstance->transferContentToTemplateEngine($templateInstance);
124
125                 /*
126                  * ... and all variables. This should be merged together in a pattern
127                  * to make things easier. A cache mechanism should be added between
128                  * these two calls to cache compiled templates.
129                  */
130                 $templateInstance->compileVariables();
131
132                 // Get the content back from the template engine and put it in response class
133                 $templateInstance->transferToResponse($responseInstance);
134         }
135
136         /**
137          * Adds extra filters to the given controller instance
138          *
139          * @param       $controllerInstance             A controller instance
140          * @param       $requestInstance                An instance of a class with an Requestable interface
141          * @return      void
142          */
143         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
144                 // Empty method
145         }
146
147 }