application/ship-simu/main/actions/class_

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