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