3 namespace Org\Mxchange\City\Command;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Command\BaseCommand;
8 use Org\Mxchange\CoreFramework\Command\Commandable;
9 use Org\Mxchange\CoreFramework\Controller\Controller;
10 use Org\Mxchange\CoreFramework\Database\Frontend\User\UserDatabaseFrontend;
11 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
12 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
13 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
14 use Org\Mxchange\CoreFramework\Request\Requestable;
15 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
16 use Org\Mxchange\CoreFramework\Response\Responseable;
19 * A command for the confirmation link handling
21 * @author Roland Haeder <webmaster@shipsimu.org>
23 * @copyright Copyright (c) 2015, 2016 City Developer Team
24 * @license GNU GPL 3.0 or any newer version
25 * @link http://www.shipsimu.org
27 * This program is free software: you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation, either version 3 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program. If not, see <http://www.gnu.org/licenses/>.
40 class CityHtmlConfirmCommand extends BaseCommand implements Commandable {
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
52 * Creates an instance of this class
54 * @param $resolverInstance An instance of a command resolver class
55 * @return $commandInstance An instance a prepared command class
57 public static final function createCityHtmlConfirmCommand (CommandResolver $resolverInstance) {
59 $commandInstance = new CityHtmlConfirmCommand();
61 // Set the application instance
62 $commandInstance->setResolverInstance($resolverInstance);
64 // Return the prepared instance
65 return $commandInstance;
69 * Executes the given command with given request and response objects
71 * @param $requestInstance An instance of a class with an Requestable interface
72 * @param $responseInstance An instance of a class with an Responseable interface
75 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
76 // Get the application instance
77 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
79 // Prepare a template instance
80 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
82 // Assign application data with template engine
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 home template
106 $templateInstance->loadCodeTemplate('confirm_link');
108 // Assign the home template with the master template as a content ... ;)
109 $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
111 // Load the master template
112 $templateInstance->loadCodeTemplate($masterTemplate);
115 $templateInstance->assignVariable('title', FrameworkBootstrap::getLanguageInstance()->getMessage('page_confirm_link_title'));
119 $userInstance = GenericRegistry::getRegistry()->getInstance('user');
120 } catch (NullPointerException $e) {
121 // Not found user, e.g. when the user is somehow invalid
122 $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
126 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseFrontend::DB_COLUMN_USERNAME));
128 // Construct the menu in every command. We could do this in BaseCommand class. But this means
129 // *every* command has a navigation system and that is want we don't want.
130 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
133 $menuInstance->renderMenu();
135 // Transfer it to the template engine instance
136 $menuInstance->transferContentToTemplateEngine($templateInstance);
139 * ... and all variables. This should be merged together in a pattern
140 * to make things easier. A cache mechanism should be added between
141 * these two calls to cache compiled templates.
143 $templateInstance->compileVariables();
145 // Get the content back from the template engine and put it in response class
146 $templateInstance->transferToResponse($responseInstance);
150 * Adds extra filters to the given controller instance
152 * @param $controllerInstance A controller instance
153 * @param $requestInstance An instance of a class with an Requestable interface
156 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {