application/city/classes/actions/html/class_HtmlCityLoginWelcomeAction.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Action\Login;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Controller\Controller;
   7 use Org\Mxchange\CoreFramework\Registry\Registerable;
   8 use Org\Mxchange\CoreFramework\Request\Requestable;
   9 use Org\Mxchange\CoreFramework\Response\Responseable;
  10
  11 /**
  12  * An action for the welcome page
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2015 - 2023 City 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 HtmlCityLoginWelcomeAction extends BaseCityAction implements Commandable, Registerable {
  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 action
  46          *
  47          * @param       $resolverInstance       An instance of an action resolver
  48          * @return      $actionInstance         An instance of this action class
  49          */
  50         public static final function createHtmlCityLoginWelcomeAction (ActionResolver $resolverInstance) {
  51                 // Get a new instance
  52                 $actionInstance = new HtmlCityLoginWelcomeAction();
  53
  54                 // Set the resolver instance
  55                 $actionInstance->setResolverInstance($resolverInstance);
  56
  57                 // Return the instance
  58                 return $actionInstance;
  59         }
  60
  61         /**
  62          * Executes the command with given request and response objects
  63          *
  64          * @param       $requestInstance        An instance of a class with an Requestable interface
  65          * @param       $responseInstance       An instance of a class with an Responseable interface
  66          * @return      void
  67          * @todo        Maybe add more here?
  68          */
  69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // Call parent execute method
  71                 parent::execute($requestInstance, $responseInstance);
  72         }
  73
  74         /**
  75          * Adds extra filters to the given controller instance
  76          *
  77          * @param       $controllerInstance             A controller instance
  78          * @param       $requestInstance                An instance of a class with an Requestable interface
  79          * @return      void
  80          * @todo        Add some filters here
  81          */
  82         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  83                 // Unfinished method
  84         }
  85 }