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