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\Factory\ObjectFactory;
10 use CoreFramework\Generic\NullPointerException;
11 use CoreFramework\Registry\Registry;
12 use CoreFramework\Request\Requestable;
13 use CoreFramework\Resolver\Command\CommandResolver;
14 use CoreFramework\Response\Responseable;
17 * A command for the confirmation link handling
19 * @author Roland Haeder <webmaster@shipsimu.org>
21 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
22 * @license GNU GPL 3.0 or any newer version
23 * @link http://www.shipsimu.org
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class HtmlConfirmCommand extends BaseCommand implements Commandable {
40 * Protected constructor
44 protected function __construct () {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
50 * Creates an instance of this class
52 * @param $resolverInstance An instance of a command resolver class
53 * @return $commandInstance An instance a prepared command class
55 public static final function createHtmlConfirmCommand (CommandResolver $resolverInstance) {
57 $commandInstance = new HtmlConfirmCommand();
59 // Set the application instance
60 $commandInstance->setResolverInstance($resolverInstance);
62 // Return the prepared instance
63 return $commandInstance;
67 * Executes the given command with given request and response objects
69 * @param $requestInstance An instance of a class with an Requestable interface
70 * @param $responseInstance An instance of a class with an Responseable interface
73 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
74 // Get the application instance
75 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
77 // Prepare a template instance
78 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
80 // Assign application data with template engine
81 $templateInstance->assignApplicationData($applicationInstance);
84 $templateInstance->assignConfigVariable('base_url');
86 // Load the master template
87 $masterTemplate = $applicationInstance->buildMasterTemplateName();
89 // Load header template
90 $templateInstance->loadCodeTemplate('header');
92 // Compile and assign it with a variable
93 $templateInstance->compileTemplate();
94 $templateInstance->assignTemplateWithVariable('header', 'header');
96 // Load footer template
97 $templateInstance->loadCodeTemplate('footer');
99 // Compile and assign it with a variable
100 $templateInstance->compileTemplate();
101 $templateInstance->assignTemplateWithVariable('footer', 'footer');
103 // Load the home template
104 $templateInstance->loadCodeTemplate('confirm_link');
106 // Assign the home template with the master template as a content ... ;)
107 $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
109 // Load the master template
110 $templateInstance->loadCodeTemplate($masterTemplate);
113 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
117 $userInstance = Registry::getRegistry()->getInstance('user');
118 } catch (NullPointerException $e) {
119 // Not found user, e.g. when the user is somehow invalid
120 $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
124 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
126 // Construct the menu in every command. We could do this in BaseCommand class. But this means
127 // *every* command has a navigation system and that is want we don't want.
128 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
131 $menuInstance->renderMenu();
133 // Transfer it to the template engine instance
134 $menuInstance->transferContentToTemplateEngine($templateInstance);
137 * ... and all variables. This should be merged together in a pattern
138 * to make things easier. A cache mechanism should be added between
139 * these two calls to cache compiled templates.
141 $templateInstance->compileVariables();
143 // Get the content back from the template engine and put it in response class
144 $templateInstance->transferToResponse($responseInstance);
148 * Adds extra filters to the given controller instance
150 * @param $controllerInstance A controller instance
151 * @param $requestInstance An instance of a class with an Requestable interface
154 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {