3 namespace Org\Mxchange\CoreFramework\Command\Register;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
7 use Org\Mxchange\CoreFramework\Command\Commandable;
8 use Org\Mxchange\CoreFramework\Controller\Controller;
9 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
10 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
11 use Org\Mxchange\CoreFramework\Request\Requestable;
12 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
13 use Org\Mxchange\CoreFramework\Response\Responseable;
16 * A command class for the registration form
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class HtmlRegisterCommand extends BaseCommand implements Commandable {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this class
51 * @param $resolverInstance An instance of a command resolver class
52 * @return $commandInstance An instance a prepared command class
54 public static final function createHtmlRegisterCommand (CommandResolver $resolverInstance) {
56 $commandInstance = new HtmlRegisterCommand();
58 // Set the application instance
59 $commandInstance->setResolverInstance($resolverInstance);
61 // Return the prepared instance
62 return $commandInstance;
66 * Executes the given command with given request and response objects
68 * @param $requestInstance An instance of a class with an Requestable interface
69 * @param $responseInstance An instance of a class with an Responseable interface
72 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 // Set request instance as extra instance
74 GenericRegistry::getRegistry()->addInstance('extra', $this);
76 // Get the application instance
77 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
79 // Prepare a template instance
80 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
82 // Assign all the application's data with template variables
83 $templateInstance->assignApplicationData();
86 $templateInstance->assignConfigVariable('base_url');
88 // Load the master template
89 $masterTemplate = $applicationInstance->buildMasterTemplateName();
91 // Load header template
92 $templateInstance->loadCodeTemplate('header');
94 // Compile and assign it with a variable
95 $templateInstance->compileTemplate();
96 $templateInstance->assignTemplateWithVariable('header', 'header');
98 // Load footer template
99 $templateInstance->loadCodeTemplate('footer');
101 // Compile and assign it with a variable
102 $templateInstance->compileTemplate();
103 $templateInstance->assignTemplateWithVariable('footer', 'footer');
105 // Load the register template
106 $templateInstance->loadCodeTemplate('register_form');
108 // Assign the register template with the master template as a content ... ;)
109 $templateInstance->compileTemplate();
110 $templateInstance->assignTemplateWithVariable('register_form', 'main_content');
112 // Load the master template
113 $templateInstance->loadCodeTemplate($masterTemplate);
116 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_register_title'));
118 // Construct the menu in every command. We could do this in BaseCommand class. But this means
119 // *every* command has a navigation system and that is want we don't want.
120 $menuInstance = ObjectFactory::createObjectByConfiguredName('register_menu_class', array($applicationInstance));
123 $menuInstance->renderMenu();
125 // Transfer it to the template engine instance
126 $menuInstance->transferContentToTemplateEngine($templateInstance);
129 * ... and all variables. This should be merged together in a pattern
130 * to make things easier. A cache mechanism should be added between
131 * these two calls to cache compiled templates.
133 $templateInstance->compileVariables();
135 // Get the content back from the template engine and put it in response class
136 $templateInstance->transferToResponse($responseInstance);
140 * Adds extra filters to the given controller instance
142 * @param $controllerInstance A controller instance
143 * @param $requestInstance An instance of a class with an Requestable interface
146 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {