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