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

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