application/city/classes/commands/html/class_CityHtmlLogoutCommand.php

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