Added 'abstract' to the class because doExecute() is abstract, too.
[core.git] / inc / classes / main / filter / class_BaseFilterDecorator.php
1 <?php
2 /**
3  * A general filter decorator for decorating filters with other filters
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
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 abstract class BaseFilterDecorator extends BaseFrameworkSystem implements Filterable {
25         /**
26          * The decorated filter instance
27          */
28         private $filterInstance = null;
29
30         /**
31          * Protected constructor
32          *
33          * @param       $className      Name of the real class' name
34          * @return      void
35          */
36         protected function __construct ($className) {
37                 // Call parent constructor
38                 parent::__construct($className);
39         }
40
41         /**
42          * Setter for the decorated filter instance
43          *
44          * @param       $filterInstance         An instance of a filter
45          * @return      void
46          */
47         protected final function setFilterInstance (Filterable $filterInstance) {
48                 $this->filterInstance = $filterInstance;
49         }
50
51         /**
52          * Getter for the decorated filter instance
53          *
54          * @return      $filterInstance         An instance of a filter
55          */
56         protected final function getFilterInstance () {
57                 return $this->filterInstance;
58         }
59
60         /**
61          * Execute the inner filter
62          *
63          * @param       $requestInstance        An instance of a request class
64          * @param       $responseInstance       An instance of a response class
65          * @return      void
66          */
67         public final function execute (Requestable $requestInstance, Responseable $responseInstance) {
68                 $this->getFilterInstance()->execute($requestInstance, $responseInstance);
69         }
70
71
72         /**
73          * Do the execution of the filter
74          *
75          * @param       $requestInstance        An instance of a request class
76          * @param       $responseInstance       An instance of a response class
77          * @return      void
78          */
79         abstract public function doExecute (Requestable $requestInstance, Responseable $responseInstance);
80 }
81
82 // [EOF]
83 ?>