application/city/classes/controller/html/class_CityHtmlLogoutController.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\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\Request\Requestable;
   9 use Org\Mxchange\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) 2015, 2016 City 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 CityHtmlLogoutController 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                 // Init additional filter chains
  45                 foreach (array('shutdown') as $filterChain) {
  46                         $this->initFilterChain($filterChain);
  47                 } // END - foreach
  48         }
  49
  50         /**
  51          * Creates an instance of this class
  52          *
  53          * @param       $resolverInstance               An instance of a command resolver class
  54          * @return      $controllerInstance             A prepared instance of this class
  55          */
  56         public static final function createCityHtmlLogoutController (CommandResolver $resolverInstance) {
  57                 // Create the instance
  58                 $controllerInstance = new CityHtmlLogoutController();
  59
  60                 // Set the command resolver
  61                 $controllerInstance->setResolverInstance($resolverInstance);
  62
  63                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
  64                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
  65
  66                 // User status filter
  67                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
  68
  69                 // Return the prepared instance
  70                 return $controllerInstance;
  71         }
  72
  73         /**
  74          * Handles the given request and response
  75          *
  76          * @param       $requestInstance        An instance of a request class
  77          * @param       $responseInstance       An instance of a response class
  78          * @return      void
  79          */
  80         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  81                 // Get the command instance
  82                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  83
  84                 // This request was valid! :-D
  85                 $requestInstance->requestIsValid();
  86
  87                 // Execute the command
  88                 $commandInstance->execute($requestInstance, $responseInstance);
  89
  90                 // Flush the response out
  91                 $responseInstance->flushBuffer();
  92         }
  93 }