More renamed
[shipsimu.git] / application / ship-simu / main / actions / class_BaseShipSimuAction.php
1 <?php
2 /**
3  * A general action class for blog
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 BaseShipSimuAction extends BaseAction {
25         /**
26          * Protected constructor
27          *
28          * @param       $className      Name of the class
29          * @return      void
30          */
31         protected function __construct ($className) {
32                 // Call parent constructor
33                 parent::__construct($className);
34         }
35
36         /**
37          * Executes the command with given request and response objects
38          *
39          * @param       $requestInstance        An instance of a class with an Requestable interface
40          * @param       $responseInstance       An instance of a class with an Responseable interface
41          * @return      void
42          * @todo        0% done
43          */
44         protected function execute (Requestable $requestInstance, Responseable $responseInstance) {
45                 // Add code here executed with every action
46         }
47
48         /**
49          * Adds extra filters to the given controller instance
50          *
51          * @param       $controllerInstance             A controller instance
52          * @param       $requestInstance                An instance of a class with an Requestable interface
53          * @return      void
54          * @todo        Add some filters here
55          */
56         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
57                 // Unfinished method
58         }
59 }
60
61 // [EOF]
62 ?>