]> git.mxchange.org Git - core.git/blob - framework/main/classes/commands/html/class_HtmlConfirmCommand.php
Continued:
[core.git] / framework / main / classes / commands / html / class_HtmlConfirmCommand.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Command\Guest;
4
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\Object\ObjectFactory;
12 use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
13 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
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;
18
19 /**
20  * A command for the confirmation link handling
21  *
22  * @author              Roland Haeder <webmaster@shipsimu.org>
23  * @version             0.0.0
24  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
25  * @license             GNU GPL 3.0 or any newer version
26  * @link                http://www.shipsimu.org
27  *
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.
32  *
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.
37  *
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/>.
40  */
41 class HtmlConfirmCommand extends BaseCommand implements Commandable {
42         /**
43          * Protected constructor
44          *
45          * @return      void
46          */
47         private function __construct () {
48                 // Call parent constructor
49                 parent::__construct(__CLASS__);
50         }
51
52         /**
53          * Creates an instance of this class
54          *
55          * @param       $resolverInstance       An instance of a command resolver class
56          * @return      $commandInstance        An instance a prepared command class
57          */
58         public static final function createHtmlConfirmCommand (CommandResolver $resolverInstance) {
59                 // Get new instance
60                 $commandInstance = new HtmlConfirmCommand();
61
62                 // Set the application instance
63                 $commandInstance->setResolverInstance($resolverInstance);
64
65                 // Return the prepared instance
66                 return $commandInstance;
67         }
68
69         /**
70          * Executes the given command with given request and response objects
71          *
72          * @param       $requestInstance        An instance of a class with an Requestable interface
73          * @param       $responseInstance       An instance of a class with an Responseable interface
74          * @return      void
75          */
76         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
77                 // Get the application instance
78                 $applicationInstance = ApplicationHelper::getSelfInstance();
79
80                 // Assign application data with template engine
81                 $this->getTemplateInstance()->assignApplicationData();
82
83                 // Assign base URL
84                 $this->getTemplateInstance()->assignConfigVariable('base_url');
85
86                 // Load the master template
87                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
88
89                 // Load header template
90                 $this->getTemplateInstance()->loadCodeTemplate('header');
91
92                 // Compile and assign it with a variable
93                 $this->getTemplateInstance()->compileTemplate();
94                 $this->getTemplateInstance()->assignTemplateWithVariable('header', 'header');
95
96                 // Load footer template
97                 $this->getTemplateInstance()->loadCodeTemplate('footer');
98
99                 // Compile and assign it with a variable
100                 $this->getTemplateInstance()->compileTemplate();
101                 $this->getTemplateInstance()->assignTemplateWithVariable('footer', 'footer');
102
103                 // Load the home template
104                 $this->getTemplateInstance()->loadCodeTemplate('confirm_link');
105
106                 // Assign the home template with the master template as a content ... ;)
107                 $this->getTemplateInstance()->assignTemplateWithVariable('confirm_link', 'main_content');
108
109                 // Load the master template
110                 $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
111
112                 // Set title
113                 $this->getTemplateInstance()->assignVariable('title', FrameworkBootstrap::getLanguageInstance()->getMessage('page_confirm_link_title'));
114
115                 // Get user instance
116                 try {
117                         $userInstance = GenericRegistry::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');
121                 }
122
123                 // Set username
124                 $this->getTemplateInstance()->assignVariable('username', $userInstance->getField(UserDatabaseFrontend::DB_COLUMN_USERNAME));
125
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');
129
130                 // Render the menu
131                 $menuInstance->renderMenu();
132
133                 // Transfer it to the template engine instance
134                 $menuInstance->transferContentToTemplateEngine($this->getTemplateInstance());
135
136                 /*
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.
140                  */
141                 $this->getTemplateInstance()->compileVariables();
142
143                 // Get the content back from the template engine and put it in response class
144                 $this->getTemplateInstance()->transferToResponse($responseInstance);
145         }
146
147         /**
148          * Adds extra filters to the given controller instance
149          *
150          * @param       $controllerInstance             A controller instance
151          * @param       $requestInstance                An instance of a class with an Requestable interface
152          * @return      void
153          */
154         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
155                 // Empty for now
156         }
157
158 }