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