3 namespace CoreFramework\Command\Login;
5 // Import framework stuff
6 use CoreFramework\Command\BaseCommand;
7 use CoreFramework\Command\Commandable;
8 use CoreFranework\Controller\Controller;
9 use CoreFramework\Factory\ObjectFactory;
10 use CoreFramework\Request\Requestable;
11 use CoreFramework\Resolver\Command\CommandResolver;
12 use CoreFramework\Response\Responseable;
15 * A command for logout
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class HtmlLogoutCommand extends BaseCommand implements Commandable {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this class
50 * @param $resolverInstance An instance of a command resolver class
51 * @return $commandInstance An instance a prepared command class
53 public static final function createHtmlLogoutCommand (CommandResolver $resolverInstance) {
55 $commandInstance = new HtmlLogoutCommand();
57 // Set the application instance
58 $commandInstance->setResolverInstance($resolverInstance);
60 // Return the prepared instance
61 return $commandInstance;
65 * Executes the given command with given request and response objects
67 * @param $requestInstance An instance of a class with an Requestable interface
68 * @param $responseInstance An instance of a class with an Responseable interface
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 // Get an auth instance for checking and updating the auth cookies
73 $authInstance = ObjectFactory::createObjectByConfiguredName('auth_method_class', array($responseInstance));
75 // Set request instance
76 $authInstance->setRequestInstance($requestInstance);
78 // Destroy the auth data
79 $authInstance->destroyAuthData();
81 // Redirect to "logout done" page
82 $responseInstance->redirectToConfiguredUrl('logout_done');
89 * Adds extra filters to the given controller instance
91 * @param $controllerInstance A controller instance
92 * @param $requestInstance An instance of a class with an Requestable interface
95 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {