db2ec310c00e49e8771f841de06dc47ebfc41f4c
[core.git] / framework / main / classes / registration / class_BaseRegistration.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Registration;
4
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Filter\Filterable;
8 use CoreFramework\Object\BaseFrameworkSystem;
9
10 /**
11  * A general registration class.
12  *
13  * @author              Roland Haeder <webmaster@shipsimu.org>
14  * @version             0.0.0
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16  * @license             GNU GPL 3.0 or any newer version
17  * @link                http://www.shipsimu.org
18  *
19  * This program is free software: you can redistribute it and/or modify
20  * it under the terms of the GNU General Public License as published by
21  * the Free Software Foundation, either version 3 of the License, or
22  * (at your option) any later version.
23  *
24  * This program is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License
30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
31  */
32 class BaseRegistration extends BaseFrameworkSystem {
33         /**
34          * Pre-registration filter chain
35          */
36         private $preRegistrationFilter = NULL;
37
38         /**
39          * Pre-registration filter chain
40          */
41         private $postRegistrationFilter = NULL;
42
43         /**
44          * Protected constructor
45          *
46          * @param       $className      Name of the class
47          * @return      void
48          */
49         protected function __construct ($className) {
50                 // Call parent constructor
51                 parent::__construct($className);
52         }
53
54         /**
55          * Initialize filters. This must be done before you can use them
56          *
57          * @return      void
58          */
59         protected function initFilterChains () {
60                 // Pre/post-registration filters
61                 $this->preRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
62                 $this->postRegistrationFilter = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
63         }
64
65         /**
66          * Adds a filter to the pre filter chain
67          *
68          * @param       $filterInstance         An instance of a filter
69          * @return      void
70          */
71         public function addPreFilter (Filterable $filterInstance) {
72                 // Add the pre filter
73                 $this->preRegistrationFilter->addFilter($filterInstance);
74         }
75
76         /**
77          * Adds a filter to the post filter chain
78          *
79          * @param       $filterInstance         An instance of a filter
80          * @return      void
81          */
82         public function addPostFilter (Filterable $filterInstance) {
83                 // Add the post filter
84                 $this->postRegistrationFilter->addFilter($filterInstance);
85         }
86
87         /**
88          * Executes all pre filters
89          *
90          * @return      void
91          */
92         protected function executePreFilters () {
93                 // Execute all pre filters
94                 $this->preRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
95         }
96
97         /**
98          * Executes all post filters
99          *
100          * @return      void
101          */
102         protected function executePostFilters () {
103                 // Execute all post filters
104                 $this->postRegistrationFilter->processFilters($this->getRequestInstance(), $this->getResponseInstance());
105         }
106
107 }