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