3 namespace CoreFramework\Command\Logout;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Request\Requestable;
8 use CoreFramework\Response\Responseable;
11 * A command for the login failed page
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class HtmlLogoutDoneCommand extends BaseCommand implements Commandable {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this class
46 * @param $resolverInstance An instance of a command resolver class
47 * @return $commandInstance An instance a prepared command class
49 public static final function createHtmlLogoutDoneCommand (CommandResolver $resolverInstance) {
51 $commandInstance = new HtmlLogoutDoneCommand();
53 // Set the application instance
54 $commandInstance->setResolverInstance($resolverInstance);
56 // Return the prepared instance
57 return $commandInstance;
61 * Executes the given command with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Get the application instance
69 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
71 // Prepare a template instance
72 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
74 // Assign application data
75 $templateInstance->assignApplicationData($applicationInstance);
77 // Load the master template
78 $masterTemplate = $applicationInstance->buildMasterTemplateName();
80 // Load header template
81 $templateInstance->loadCodeTemplate('header');
83 // Compile and assign it with a variable
84 $templateInstance->compileTemplate();
85 $templateInstance->assignTemplateWithVariable('header', 'header');
87 // Load footer template
88 $templateInstance->loadCodeTemplate('footer');
90 // Compile and assign it with a variable
91 $templateInstance->compileTemplate();
92 $templateInstance->assignTemplateWithVariable('footer', 'footer');
94 // Load the logout_done template
95 $templateInstance->loadCodeTemplate('logout_done');
97 // Assign the logout_done template with the master template as a content ... ;)
98 $templateInstance->assignTemplateWithVariable('logout_done', 'main_content');
100 // Load the master template
101 $templateInstance->loadCodeTemplate($masterTemplate);
104 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('logout_done_title'));
107 $templateInstance->assignConfigVariable('base_url');
109 // Construct the menu in every command. We could do this in BaseCommand class. But this means
110 // *every* command has a navigation system and that is want we don't want.
111 $menuInstance = ObjectFactory::createObjectByConfiguredName('logout_menu_class', array($applicationInstance));
114 $menuInstance->renderMenu();
116 // Transfer it to the template engine instance
117 $menuInstance->transferContentToTemplateEngine($templateInstance);
120 * ... and all variables. This should be merged together in a pattern
121 * to make things easier. A cache mechanism should be added between
122 * these two calls to cache compiled templates.
124 $templateInstance->compileVariables();
126 // Get the content back from the template engine and put it in response class
127 $templateInstance->transferToResponse($responseInstance);
131 * Adds extra filters to the given controller instance
133 * @param $controllerInstance A controller instance
134 * @param $requestInstance An instance of a class with an Requestable interface
137 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {