3 * A command for the confirmation link handling
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class WebConfirmCommand extends BaseCommand implements Commandable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $resolverInstance An instance of a command resolver class
39 * @return $commandInstance An instance a prepared command class
41 public static final function createWebConfirmCommand (CommandResolver $resolverInstance) {
43 $commandInstance = new WebConfirmCommand();
45 // Set the application instance
46 $commandInstance->setResolverInstance($resolverInstance);
48 // Return the prepared instance
49 return $commandInstance;
53 * Executes the given command with given request and response objects
55 * @param $requestInstance An instance of a class with an Requestable interface
56 * @param $responseInstance An instance of a class with an Responseable interface
59 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60 // Get the application instance
61 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
63 // Prepare a template instance
64 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
66 // Assign application data with template engine
67 $templateInstance->assignApplicationData($applicationInstance);
70 $templateInstance->assignConfigVariable('base_url');
72 // Load the master template
73 $masterTemplate = $applicationInstance->buildMasterTemplateName();
75 // Load header template
76 $templateInstance->loadCodeTemplate('header');
78 // Compile and assign it with a variable
79 $templateInstance->compileTemplate();
80 $templateInstance->assignTemplateWithVariable('header', 'header');
82 // Load footer template
83 $templateInstance->loadCodeTemplate('footer');
85 // Compile and assign it with a variable
86 $templateInstance->compileTemplate();
87 $templateInstance->assignTemplateWithVariable('footer', 'footer');
89 // Load the home template
90 $templateInstance->loadCodeTemplate('confirm_link');
92 // Assign the home template with the master template as a content ... ;)
93 $templateInstance->assignTemplateWithVariable('confirm_link', 'content');
95 // Load the master template
96 $templateInstance->loadCodeTemplate($masterTemplate);
99 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
103 $userInstance = Registry::getRegistry()->getInstance('user');
104 } catch (NullPointerException $e) {
105 // Not found user, e.g. when the user is somehow invalid
106 $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
110 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
112 // Construct the menu in every command. We could do this in BaseCommand class. But this means
113 // *every* command has a navigation system and that is want we don't want.
114 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
117 $menuInstance->renderMenu();
119 // Transfer it to the template engine instance
120 $menuInstance->transferContentToTemplateEngine($templateInstance);
123 * ... and all variables. This should be merged together in a pattern
124 * to make things easier. A cache mechanism should be added between
125 * these two calls to cache compiled templates.
127 $templateInstance->compileVariables();
129 // Get the content back from the template engine and put it in response class
130 $templateInstance->transferToResponse($responseInstance);
134 * Adds extra filters to the given controller instance
136 * @param $controllerInstance A controller instance
137 * @param $requestInstance An instance of a class with an Requestable interface
140 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {