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\Helper\Application\ApplicationHelper;
14 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
15 use Org\Mxchange\CoreFramework\Request\Requestable;
16 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
17 use Org\Mxchange\CoreFramework\Response\Responseable;
20 * A command for the confirmation link handling
22 * @author Roland Haeder <webmaster@shipsimu.org>
24 * @copyright Copyright (c) 2015, 2016 City Developer Team
25 * @license GNU GPL 3.0 or any newer version
26 * @link http://www.shipsimu.org
28 * This program is free software: you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License as published by
30 * the Free Software Foundation, either version 3 of the License, or
31 * (at your option) any later version.
33 * This program is distributed in the hope that it will be useful,
34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 * GNU General Public License for more details.
38 * You should have received a copy of the GNU General Public License
39 * along with this program. If not, see <http://www.gnu.org/licenses/>.
41 class CityHtmlConfirmCommand extends BaseCommand implements Commandable {
43 * Protected constructor
47 protected function __construct () {
48 // Call parent constructor
49 parent::__construct(__CLASS__);
53 * Creates an instance of this class
55 * @param $resolverInstance An instance of a command resolver class
56 * @return $commandInstance An instance a prepared command class
58 public static final function createCityHtmlConfirmCommand (CommandResolver $resolverInstance) {
60 $commandInstance = new CityHtmlConfirmCommand();
62 // Set the application instance
63 $commandInstance->setResolverInstance($resolverInstance);
65 // Return the prepared instance
66 return $commandInstance;
70 * Executes the given command with given request and response objects
72 * @param $requestInstance An instance of a class with an Requestable interface
73 * @param $responseInstance An instance of a class with an Responseable interface
76 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
77 // Get the application instance
78 $applicationInstance = ApplicationHelper::getSelfInstance();
80 // Prepare a template instance
81 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
83 // Assign application data with template engine
84 $templateInstance->assignApplicationData();
87 $templateInstance->assignConfigVariable('base_url');
89 // Load the master template
90 $masterTemplate = $applicationInstance->buildMasterTemplateName();
92 // Load header template
93 $templateInstance->loadCodeTemplate('header');
95 // Compile and assign it with a variable
96 $templateInstance->compileTemplate();
97 $templateInstance->assignTemplateWithVariable('header', 'header');
99 // Load footer template
100 $templateInstance->loadCodeTemplate('footer');
102 // Compile and assign it with a variable
103 $templateInstance->compileTemplate();
104 $templateInstance->assignTemplateWithVariable('footer', 'footer');
106 // Load the home template
107 $templateInstance->loadCodeTemplate('confirm_link');
109 // Assign the home template with the master template as a content ... ;)
110 $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
112 // Load the master template
113 $templateInstance->loadCodeTemplate($masterTemplate);
116 $templateInstance->assignVariable('title', FrameworkBootstrap::getLanguageInstance()->getMessage('page_confirm_link_title'));
120 $userInstance = GenericRegistry::getRegistry()->getInstance('user');
121 } catch (NullPointerException $e) {
122 // Not found user, e.g. when the user is somehow invalid
123 $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
127 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseFrontend::DB_COLUMN_USERNAME));
129 // Construct the menu in every command. We could do this in BaseCommand class. But this means
130 // *every* command has a navigation system and that is want we don't want.
131 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
134 $menuInstance->renderMenu();
136 // Transfer it to the template engine instance
137 $menuInstance->transferContentToTemplateEngine($templateInstance);
140 * ... and all variables. This should be merged together in a pattern
141 * to make things easier. A cache mechanism should be added between
142 * these two calls to cache compiled templates.
144 $templateInstance->compileVariables();
146 // Get the content back from the template engine and put it in response class
147 $templateInstance->transferToResponse($responseInstance);
151 * Adds extra filters to the given controller instance
153 * @param $controllerInstance A controller instance
154 * @param $requestInstance An instance of a class with an Requestable interface
157 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {