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