inc/main/classes/controller/html/class_HtmlLogoutController.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Controller\Logout;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7 use CoreFramework\Request\Requestable;
   8
   9 /**
  10  * The default controller for logout page
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  * @todo                This controller shall still provide some headlines for sidebars
  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 HtmlLogoutController extends BaseController implements Controller {
  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      $controllerInstance             A prepared instance of this class
  48          */
  49         public static final function createHtmlLogoutController (CommandResolver $resolverInstance) {
  50                 // Create the instance
  51                 $controllerInstance = new HtmlLogoutController();
  52
  53                 // Set the command resolver
  54                 $controllerInstance->setResolverInstance($resolverInstance);
  55
  56                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
  57                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
  58
  59                 // User status filter
  60                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
  61
  62                 // Return the prepared instance
  63                 return $controllerInstance;
  64         }
  65
  66         /**
  67          * Handles the given request and response
  68          *
  69          * @param       $requestInstance        An instance of a Requestable class
  70          * @param       $responseInstance       An instance of a Responsable class
  71          * @return      void
  72          */
  73         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  74                 // Get the command instance
  75                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  76
  77                 // This request was valid! :-D
  78                 $requestInstance->requestIsValid();
  79
  80                 // Execute the command
  81                 $commandInstance->execute($requestInstance, $responseInstance);
  82
  83                 // Flush the response out
  84                 $responseInstance->flushBuffer();
  85         }
  86
  87 }