3 namespace CoreFramework\Filter\RulesCheckbox;
5 // Import framework stuff
6 use CoreFramework\Request\Requestable;
7 use CoreFramework\Response\Responseable;
10 * A filter for checking if the user has accepted the rules. This is mainly
11 * used and done in registration process and should not be removed from your
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class RulesAcceptedFilter extends BaseFilter implements Filterable {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this filter class
47 * @return $filterInstance An instance of this filter class
49 public static final function createRulesAcceptedFilter () {
51 $filterInstance = new RulesAcceptedFilter();
53 // Return the instance
54 return $filterInstance;
58 * Executes the filter with given request and response objects
60 * @param $requestInstance An instance of a class with an Requestable interface
61 * @param $responseInstance An instance of a class with an Responseable interface
63 * @throws FilterChainException If this filter fails to operate
65 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
66 // Get the "rules" value from request
67 $rules = $requestInstance->getRequestElement('rules');
69 // Was the "rules" value found in form? And is it set?
70 if (is_null($rules)) {
71 // Not found in form so stop processing here
72 $requestInstance->requestIsValid(FALSE);
74 // Add a message to the response
75 $responseInstance->addFatalMessage('rules_unchecked');
77 // Skip further processing
78 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);