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 use CoreFramework\Request\Requestable;
   8 use CoreFramework\Response\Responseable;
   9
  10 /**
  11  * A command for logout
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  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
  18  *
  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.
  23  *
  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.
  28  *
  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/>.
  31  */
  32 class HtmlLogoutCommand extends BaseCommand implements Commandable {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this class
  45          *
  46          * @param       $resolverInstance       An instance of a command resolver class
  47          * @return      $commandInstance        An instance a prepared command class
  48          */
  49         public static final function createHtmlLogoutCommand (CommandResolver $resolverInstance) {
  50                 // Get new instance
  51                 $commandInstance = new HtmlLogoutCommand();
  52
  53                 // Set the application instance
  54                 $commandInstance->setResolverInstance($resolverInstance);
  55
  56                 // Return the prepared instance
  57                 return $commandInstance;
  58         }
  59
  60         /**
  61          * Executes the given command with given request and response objects
  62          *
  63          * @param       $requestInstance        An instance of a class with an Requestable interface
  64          * @param       $responseInstance       An instance of a class with an Responseable interface
  65          * @return      void
  66          */
  67         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  68                 // Get an auth instance for checking and updating the auth cookies
  69                 $authInstance = ObjectFactory::createObjectByConfiguredName('auth_method_class', array($responseInstance));
  70
  71                 // Set request instance
  72                 $authInstance->setRequestInstance($requestInstance);
  73
  74                 // Destroy the auth data
  75                 $authInstance->destroyAuthData();
  76
  77                 // Redirect to "logout done" page
  78                 $responseInstance->redirectToConfiguredUrl('logout_done');
  79
  80                 // Exit here
  81                 exit();
  82         }
  83
  84         /**
  85          * Adds extra filters to the given controller instance
  86          *
  87          * @param       $controllerInstance             A controller instance
  88          * @param       $requestInstance                An instance of a class with an Requestable interface
  89          * @return      void
  90          */
  91         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  92                 // Empty for now
  93         }
  94
  95 }