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