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\Request\Requestable;
   8 use Org\Mxchange\CoreFramework\Response\Responseable;
   9
  10 /**
  11  *
  12  *
  13  * @author              Roland Haeder <webmaster@ship-simu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.ship-simu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class ???Action extends BaseCityAction implements Commandable, Registerable {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this action
  45          *
  46          * @param       $resolverInstance       An instance of an action resolver
  47          * @return      $actionInstance         An instance of this action class
  48          */
  49         public final static function create???Action (ActionResolver $resolverInstance) {
  50                 // Get a new instance
  51                 $actionInstance = new ???Action();
  52
  53                 // Return the instance
  54                 return $actionInstance;
  55         }
  56
  57         /**
  58          * Executes the command with given request and response objects
  59          *
  60          * @param       $requestInstance        An instance of a class with an Requestable interface
  61          * @param       $responseInstance       An instance of a class with an Responseable interface
  62          * @return      void
  63          * @todo        0% done
  64          */
  65         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  66                 // Call parent execute method
  67                 parent::execute($requestInstance, $responseInstance);
  68
  69                 // Add your code here
  70                 $this->partialStub("You have to implement me.");
  71         }
  72
  73         /**
  74          * Adds extra filters to the given controller instance
  75          *
  76          * @param       $controllerInstance             A controller instance
  77          * @param       $requestInstance                An instance of a class with an Requestable interface
  78          * @return      void
  79          * @todo        Add some filters here
  80          */
  81         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  82                 // Call parent addExtraFilters method
  83                 parent::addExtraFilters($controllerInstance, $requestInstance);
  84
  85                 // Unfinished method
  86         }
  87 }