application/city/classes/actions/class_

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Action;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Controller\Controller;
   7 use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
   8 use Org\Mxchange\CoreFramework\Registry\Registerable;
   9 use Org\Mxchange\CoreFramework\Request\Requestable;
  10 use Org\Mxchange\CoreFramework\Response\Responseable;
  11
  12 /**
  13  *
  14  *
  15  * @author              Roland Haeder <webmaster@ship-simu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.ship-simu.org
  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 ???Action extends BaseCityAction implements Commandable, Registerable {
  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 action
  47          *
  48          * @param       $resolverInstance       An instance of an action resolver
  49          * @return      $actionInstance         An instance of this action class
  50          */
  51         public final static function create???Action (ActionResolver $resolverInstance) {
  52                 // Get a new instance
  53                 $actionInstance = new ???Action();
  54
  55                 // Return the instance
  56                 return $actionInstance;
  57         }
  58
  59         /**
  60          * Executes the command with given request and response objects
  61          *
  62          * @param       $requestInstance        An instance of a class with an Requestable interface
  63          * @param       $responseInstance       An instance of a class with an Responseable interface
  64          * @return      void
  65          * @todo        0% done
  66          */
  67         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  68                 // Call parent execute method
  69                 parent::execute($requestInstance, $responseInstance);
  70
  71                 // Add your code here
  72                 DebugMiddleware::getSelfInstance()->partialStub("You have to implement me.");
  73         }
  74
  75         /**
  76          * Adds extra filters to the given controller instance
  77          *
  78          * @param       $controllerInstance             A controller instance
  79          * @param       $requestInstance                An instance of a class with an Requestable interface
  80          * @return      void
  81          * @todo        Add some filters here
  82          */
  83         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  84                 // Call parent addExtraFilters method
  85                 parent::addExtraFilters($controllerInstance, $requestInstance);
  86
  87                 // Unfinished method
  88         }
  89 }