3 namespace CoreFramework\Command\Register;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Registry\Registerable;
8 use CoreFramework\Registry\Generic\Registry;
11 * A command class for the registration form
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class HtmlRegisterCommand extends BaseCommand implements Commandable, Registerable {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this class
46 * @param $resolverInstance An instance of a command resolver class
47 * @return $commandInstance An instance a prepared command class
49 public static final function createHtmlRegisterCommand (CommandResolver $resolverInstance) {
51 $commandInstance = new HtmlRegisterCommand();
53 // Set the application instance
54 $commandInstance->setResolverInstance($resolverInstance);
56 // Return the prepared instance
57 return $commandInstance;
61 * Executes the given command with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Set request instance as extra instance
69 Registry::getRegistry()->addInstance('extra', $this);
71 // Get the application instance
72 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
74 // Prepare a template instance
75 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
77 // Assign all the application's data with template variables
78 $templateInstance->assignApplicationData($applicationInstance);
81 $templateInstance->assignConfigVariable('base_url');
83 // Load the master template
84 $masterTemplate = $applicationInstance->buildMasterTemplateName();
86 // Load header template
87 $templateInstance->loadCodeTemplate('header');
89 // Compile and assign it with a variable
90 $templateInstance->compileTemplate();
91 $templateInstance->assignTemplateWithVariable('header', 'header');
93 // Load footer template
94 $templateInstance->loadCodeTemplate('footer');
96 // Compile and assign it with a variable
97 $templateInstance->compileTemplate();
98 $templateInstance->assignTemplateWithVariable('footer', 'footer');
100 // Load the register template
101 $templateInstance->loadCodeTemplate('register_form');
103 // Assign the register template with the master template as a content ... ;)
104 $templateInstance->compileTemplate();
105 $templateInstance->assignTemplateWithVariable('register_form', 'main_content');
107 // Load the master template
108 $templateInstance->loadCodeTemplate($masterTemplate);
111 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_register_title'));
113 // Construct the menu in every command. We could do this in BaseCommand class. But this means
114 // *every* command has a navigation system and that is want we don't want.
115 $menuInstance = ObjectFactory::createObjectByConfiguredName('register_menu_class', array($applicationInstance));
118 $menuInstance->renderMenu();
120 // Transfer it to the template engine instance
121 $menuInstance->transferContentToTemplateEngine($templateInstance);
124 * ... and all variables. This should be merged together in a pattern
125 * to make things easier. A cache mechanism should be added between
126 * these two calls to cache compiled templates.
128 $templateInstance->compileVariables();
130 // Get the content back from the template engine and put it in response class
131 $templateInstance->transferToResponse($responseInstance);
135 * Adds extra filters to the given controller instance
137 * @param $controllerInstance A controller instance
138 * @param $requestInstance An instance of a class with an Requestable interface
141 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {