inc/main/classes/controller/html/class_HtmlLoginController.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Controller\Login;
   4
   5 // Import framework stuff
   6 use CoreFramework\Controller\BaseController;
   7 use CoreFramework\Request\Requestable;
   8 use CoreFramework\Response\Responseable;
   9
  10 /**
  11  * Controller for login form with password reminder and maybe enabled
  12  * "guest-login" button
  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  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class HtmlLoginController extends BaseController implements Controller {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @param       $resolverInstance               An instance of a command resolver class
  48          * @return      $controllerInstance             A prepared instance of this class
  49          * @todo        Add some filters to this controller
  50          */
  51         public static final function createHtmlLoginController (CommandResolver $resolverInstance) {
  52                 // Create the instance
  53                 $controllerInstance = new HtmlLoginController();
  54
  55                 // Set the command resolver
  56                 $controllerInstance->setResolverInstance($resolverInstance);
  57
  58                 // Return the prepared instance
  59                 return $controllerInstance;
  60         }
  61
  62         /**
  63          * Handles the given request and response
  64          *
  65          * @param       $requestInstance        An instance of a Requestable class
  66          * @param       $responseInstance       An instance of a Responseable class
  67          * @return      void
  68          */
  69         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // Generic pre-post command execution
  71                 $this->executeGenericPrePostCommand($requestInstance, $responseInstance);
  72         }
  73
  74 }