framework/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\Controller\BaseController;
   7 use CoreFramework\Controller\Controller;
   8 use CoreFramework\Factory\ObjectFactory;
   9 use CoreFramework\Request\Requestable;
  10 use CoreFramework\Resolver\Command\CommandResolver;
  11 use CoreFramework\Response\Responseable;
  12
  13 /**
  14  * The default controller for logout page
  15  *
  16  * @author              Roland Haeder <webmaster@shipsimu.org>
  17  * @version             0.0.0
  18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  19  * @license             GNU GPL 3.0 or any newer version
  20  * @link                http://www.shipsimu.org
  21  * @todo                This controller shall still provide some headlines for sidebars
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class HtmlLogoutController extends BaseController implements Controller {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this class
  49          *
  50          * @param       $resolverInstance               An instance of a command resolver class
  51          * @return      $controllerInstance             A prepared instance of this class
  52          */
  53         public static final function createHtmlLogoutController (CommandResolver $resolverInstance) {
  54                 // Create the instance
  55                 $controllerInstance = new HtmlLogoutController();
  56
  57                 // Set the command resolver
  58                 $controllerInstance->setResolverInstance($resolverInstance);
  59
  60                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
  61                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
  62
  63                 // User status filter
  64                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
  65
  66                 // Return the prepared instance
  67                 return $controllerInstance;
  68         }
  69
  70         /**
  71          * Handles the given request and response
  72          *
  73          * @param       $requestInstance        An instance of a Requestable class
  74          * @param       $responseInstance       An instance of a Responseable class
  75          * @return      void
  76          */
  77         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  78                 // Get the command instance
  79                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  80
  81                 // This request was valid! :-D
  82                 $requestInstance->requestIsValid();
  83
  84                 // Execute the command
  85                 $commandInstance->execute($requestInstance, $responseInstance);
  86
  87                 // Flush the response out
  88                 $responseInstance->flushBuffer();
  89         }
  90
  91 }