application/city/classes/actions/class_BaseCityAction.php

   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  * A general action class for city
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.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.shipsimu.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 BaseCityAction extends BaseAction {
  32         /**
  33          * Protected constructor
  34          *
  35          * @param       $className      Name of the class
  36          * @return      void
  37          */
  38         protected function __construct ($className) {
  39                 // Call parent constructor
  40                 parent::__construct($className);
  41         }
  42
  43         /**
  44          * Executes the command with given request and response objects
  45          *
  46          * @param       $requestInstance        An instance of a class with an Requestable interface
  47          * @param       $responseInstance       An instance of a class with an Responseable interface
  48          * @return      void
  49          * @todo        0% done
  50          */
  51         protected function execute (Requestable $requestInstance, Responseable $responseInstance) {
  52                 // Add code here executed with every action
  53         }
  54
  55         /**
  56          * Adds extra filters to the given controller instance
  57          *
  58          * @param       $controllerInstance             A controller instance
  59          * @param       $requestInstance                An instance of a class with an Requestable interface
  60          * @return      void
  61          * @todo        Add some filters here
  62          */
  63         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  64                 // Unfinished method
  65         }
  66 }