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

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