inc/classes/main/commands/web/class_WebLogoutCommand.php

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