3 namespace CoreFramework\Command\Guest;
5 // Import framework stuff
6 use CoreFramework\Command\BaseCommand;
7 use CoreFramework\Command\Commandable;
8 use CoreFramework\Controller\Controller;
9 use CoreFramework\Database\Frontend\User\UserDatabaseWrapper;
10 use CoreFramework\Factory\ObjectFactory;
11 use CoreFramework\Generic\NullPointerException;
12 use CoreFramework\Registry\Registry;
13 use CoreFramework\Request\Requestable;
14 use CoreFramework\Resolver\Command\CommandResolver;
15 use CoreFramework\Response\Responseable;
18 * A command for the confirmation link handling
20 * @author Roland Haeder <webmaster@shipsimu.org>
22 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
23 * @license GNU GPL 3.0 or any newer version
24 * @link http://www.shipsimu.org
26 * This program is free software: you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License as published by
28 * the Free Software Foundation, either version 3 of the License, or
29 * (at your option) any later version.
31 * This program is distributed in the hope that it will be useful,
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34 * GNU General Public License for more details.
36 * You should have received a copy of the GNU General Public License
37 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 class HtmlConfirmCommand extends BaseCommand implements Commandable {
41 * Protected constructor
45 protected function __construct () {
46 // Call parent constructor
47 parent::__construct(__CLASS__);
51 * Creates an instance of this class
53 * @param $resolverInstance An instance of a command resolver class
54 * @return $commandInstance An instance a prepared command class
56 public static final function createHtmlConfirmCommand (CommandResolver $resolverInstance) {
58 $commandInstance = new HtmlConfirmCommand();
60 // Set the application instance
61 $commandInstance->setResolverInstance($resolverInstance);
63 // Return the prepared instance
64 return $commandInstance;
68 * Executes the given command with given request and response objects
70 * @param $requestInstance An instance of a class with an Requestable interface
71 * @param $responseInstance An instance of a class with an Responseable interface
74 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
75 // Get the application instance
76 $applicationInstance = Registry::getRegistry()->getInstance('app');
78 // Prepare a template instance
79 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
81 // Assign application data with template engine
82 $templateInstance->assignApplicationData($applicationInstance);
85 $templateInstance->assignConfigVariable('base_url');
87 // Load the master template
88 $masterTemplate = $applicationInstance->buildMasterTemplateName();
90 // Load header template
91 $templateInstance->loadCodeTemplate('header');
93 // Compile and assign it with a variable
94 $templateInstance->compileTemplate();
95 $templateInstance->assignTemplateWithVariable('header', 'header');
97 // Load footer template
98 $templateInstance->loadCodeTemplate('footer');
100 // Compile and assign it with a variable
101 $templateInstance->compileTemplate();
102 $templateInstance->assignTemplateWithVariable('footer', 'footer');
104 // Load the home template
105 $templateInstance->loadCodeTemplate('confirm_link');
107 // Assign the home template with the master template as a content ... ;)
108 $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
110 // Load the master template
111 $templateInstance->loadCodeTemplate($masterTemplate);
114 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
118 $userInstance = Registry::getRegistry()->getInstance('user');
119 } catch (NullPointerException $e) {
120 // Not found user, e.g. when the user is somehow invalid
121 $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
125 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
127 // Construct the menu in every command. We could do this in BaseCommand class. But this means
128 // *every* command has a navigation system and that is want we don't want.
129 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
132 $menuInstance->renderMenu();
134 // Transfer it to the template engine instance
135 $menuInstance->transferContentToTemplateEngine($templateInstance);
138 * ... and all variables. This should be merged together in a pattern
139 * to make things easier. A cache mechanism should be added between
140 * these two calls to cache compiled templates.
142 $templateInstance->compileVariables();
144 // Get the content back from the template engine and put it in response class
145 $templateInstance->transferToResponse($responseInstance);
149 * Adds extra filters to the given controller instance
151 * @param $controllerInstance A controller instance
152 * @param $requestInstance An instance of a class with an Requestable interface
155 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {