Copyright updated, interface RenderableMenu added
[core.git] / inc / classes / main / filter / null / class_NullFilter.php
1 <?php
2 /**
3  * As the name said: A null filter does just pass through the data. This is
4  * useful to make other filters switch on/off-able.
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class NullFilter extends BaseFilter implements Filterable {
26         /**
27          * Protected constructor
28          *
29          * @return      void
30          */
31         protected function __construct () {
32                 // Call parent constructor
33                 parent::__construct(__CLASS__);
34         }
35
36         /**
37          * Creates an instance of this filter class
38          *
39          * @return      $filterInstance                 An instance of this filter class
40          */
41         public final static function createNullFilter () {
42                 // Get a new instance
43                 $filterInstance = new NullFilter();
44
45                 // Return the instance
46                 return $filterInstance;
47         }
48
49         /**
50          * Executes the filter 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          */
56         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
57                 // Not implemented, just passing through
58         }
59 }
60
61 // [EOF]
62 ?>