Copyright updated
[core.git] / inc / classes / main / registration / class_BaseRegistration.php
1 <?php
2 /**
3  * A general registration class.
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007 - 2009 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 BaseRegistration extends BaseFrameworkSystem {
25         /**
26          * Pre-registration filter chain
27          */
28         private $preRegistrationFilter = null;
29
30         /**
31          * Pre-registration filter chain
32          */
33         private $postRegistrationFilter = null;
34
35         /**
36          * Protected constructor
37          *
38          * @param       $className      Name of the class
39          * @return      void
40          */
41         protected function __construct ($className) {
42                 // Call parent constructor
43                 parent::__construct($className);
44
45                 // Clean up a little
46                 $this->removeNumberFormaters();
47                 $this->removeSystemArray();
48         }
49
50         /**
51          * Initialize filters. This must be done before you can use them
52          *
53          * @return      void
54          */
55         protected function initFilterChains () {
56                 // Pre/post-registration filters
57                 $this->preRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
58                 $this->postRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
59         }
60
61         /**
62          * Adds a filter to the pre filter chain
63          *
64          * @param       $filterInstance         An instance of a filter
65          * @return      void
66          */
67         public function addPreFilter (Filterable $filterInstance) {
68                 // Add the pre filter
69                 $this->preRegistrationFilter->addFilter($filterInstance);
70         }
71
72         /**
73          * Adds a filter to the post filter chain
74          *
75          * @param       $filterInstance         An instance of a filter
76          * @return      void
77          */
78         public function addPostFilter (Filterable $filterInstance) {
79                 // Add the post filter
80                 $this->postRegistrationFilter->addFilter($filterInstance);
81         }
82
83         /**
84          * Executes all pre filters
85          *
86          * @return      void
87          */
88         protected function executePreFilters () {
89                 // Execute all pre filters
90                 $this->preRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
91         }
92
93         /**
94          * Executes all post filters
95          *
96          * @return      void
97          */
98         protected function executePostFilters () {
99                 // Execute all post filters
100                 $this->postRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
101         }
102 }
103
104 // [EOF]
105 ?>