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

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