3 namespace Org\Mxchange\CoreFramework\Filter\Validator\Password;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
7 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
8 use Org\Mxchange\CoreFramework\Filter\Filterable;
9 use Org\Mxchange\CoreFramework\Request\Requestable;
10 use Org\Mxchange\CoreFramework\Response\Responseable;
13 * A concrete filter for validating the password. This filter may intercept
14 * the filter chain if no password is given or if both passwords didn't match.
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 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 PasswordValidatorFilter extends BaseFilter implements Filterable {
37 * Protected constructor
41 private 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 createPasswordValidatorFilter () {
53 $filterInstance = new PasswordValidatorFilter();
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) {
69 $password1 = $requestInstance->getRequestElement('pass1');
70 $password2 = $requestInstance->getRequestElement('pass2');
72 // Is the password still not set?
73 if ((is_null($password1)) || (is_null($password2))) {
74 // Not found in form so stop the filtering process
75 $requestInstance->requestIsValid(false);
77 // Add a message to the response
78 $responseInstance->addFatalMessage('password_unset');
81 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
82 } elseif ((empty($password1)) || (empty($password2))) {
84 $requestInstance->requestIsValid(false);
86 // Is the password empty?
87 if (empty($password1)) {
88 // Add a message to the response
89 $responseInstance->addFatalMessage('pass1_empty');
92 // Is the confirmation empty?
93 if (empty($password2)) {
94 // Add a message to the response
95 $responseInstance->addFatalMessage('pass2_empty');
99 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
100 } elseif ($password1 != $password2) {
101 // Passwords didn't match
102 $requestInstance->requestIsValid(false);
104 // Add a message to the response
105 $responseInstance->addFatalMessage('pass_mismatch');
108 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);