inc/main/classes/commands/html/class_HtmlLogoutCommand.php

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