framework/main/classes/commands/class_

   1 <?php
   2 /**
   3  *
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7 <<<<<<< HEAD:framework/main/classes/commands/class_
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
   9 =======
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  11 >>>>>>> Some updates::inc/main/classes/commands/class_
  12  * @license             GNU GPL 3.0 or any newer version
  13  * @link                http://www.ship-simu.org
  14  *
  15  * This program is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation, either version 3 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  27  */
  28 class ???Command extends BaseCommand implements Commandable {
  29         /**
  30          * Protected constructor
  31          *
  32          * @return      void
  33          */
  34         protected function __construct () {
  35                 // Call parent constructor
  36                 parent::__construct(__CLASS__);
  37         }
  38
  39         /**
  40          * Creates an instance of this class
  41          *
  42          * @param       $resolverInstance       An instance of a command resolver class
  43          * @return      $commandInstance        An instance a prepared command class
  44          */
  45         public final static function create???Command (CommandResolver $resolverInstance) {
  46                 // Get new instance
  47                 $commandInstance = new ???Command();
  48
  49                 // Set the application instance
  50                 $commandInstance->setResolverInstance($resolverInstance);
  51
  52                 // Return the prepared instance
  53                 return $commandInstance;
  54         }
  55
  56         /**
  57          * Executes the given 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          */
  63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  64                 $this->partialStub('Unfinished!');
  65         }
  66
  67         /**
  68          * Adds extra filters to the given controller instance
  69          *
  70          * @param       $controllerInstance             A controller instance
  71          * @param       $requestInstance                An instance of a class with an Requestable interface
  72          * @return      void
  73          */
  74         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  75                 $this->partialStub('Unfinished!');
  76         }
  77
  78 }