Method redirectToConfiguredUrl() does now append the suffix '_url' to all config...
[core.git] / inc / classes / main / filter / checkboxes / class_RulesAcceptedFilter.php
1 <?php
2 /**
3  * A filter for checking if the user has accepted the rules. This is mainly
4  * used and done in registration process and should not be removed from your
5  * application.
6  *
7  * @author              Roland Haeder <webmaster@ship-simu.org>
8  * @version             0.0.0
9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
10  * @license             GNU GPL 3.0 or any newer version
11  * @link                http://www.ship-simu.org
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation, either version 3 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
25  */
26 class RulesAcceptedFilter extends BaseFilter implements Filterable {
27         /**
28          * Protected constructor
29          *
30          * @return      void
31          */
32         protected function __construct () {
33                 // Call parent constructor
34                 parent::__construct(__CLASS__);
35         }
36
37         /**
38          * Creates an instance of this filter class
39          *
40          * @return      $filterInstance                 An instance of this filter class
41          */
42         public final static function createRulesAcceptedFilter () {
43                 // Get a new instance
44                 $filterInstance = new RulesAcceptedFilter();
45
46                 // Return the instance
47                 return $filterInstance;
48         }
49
50         /**
51          * Executes the filter with given request and response objects
52          *
53          * @param       $requestInstance        An instance of a class with an Requestable interface
54          * @param       $responseInstance       An instance of a class with an Responseable interface
55          * @return      void
56          */
57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
58                 // Get the "rules" value from request
59                 $rules = $requestInstance->getRequestElement('rules');
60
61                 // Was the "rules" value found in form? And is it set?
62                 if (is_null($rules)) {
63                         // Not found in form so stop processing here
64                         $requestInstance->requestIsValid(false);
65
66                         // Add a message to the response
67                         $responseInstance->addFatalMessage('rules_unchecked');
68
69                         // Skip further processing
70                         return false;
71                 }
72         }
73 }
74
75 // [EOF]
76 ?>