3 namespace CoreFramework\Filter\RulesCheckbox;
5 // Import framework stuff
6 use CoreFramework\Filter\BaseFilter;
7 use CoreFramework\Filter\Filterable;
8 use CoreFramework\Request\Requestable;
9 use CoreFramework\Response\Responseable;
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
16 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
35 class RulesAcceptedFilter extends BaseFilter implements Filterable {
37 * Protected constructor
41 protected function __construct () {
42 // Call parent constructor
43 parent::__construct(__CLASS__);
47 * Creates an instance of this filter class
49 * @return $filterInstance An instance of this filter class
51 public static final function createRulesAcceptedFilter () {
53 $filterInstance = new RulesAcceptedFilter();
55 // Return the instance
56 return $filterInstance;
60 * Executes the filter with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
65 * @throws FilterChainException If this filter fails to operate
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Get the "rules" value from request
69 $rules = $requestInstance->getRequestElement('rules');
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);
76 // Add a message to the response
77 $responseInstance->addFatalMessage('rules_unchecked');
79 // Skip further processing
80 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);