3 namespace CoreFramework\Filter\Verifier\User;
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 concrete filter for validating the guest password. This filter may intercept
13 * the filter chain if no password is given or the password is invalid
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class PasswordGuestVerifierFilter extends BaseFilter implements Filterable {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this filter class
48 * @return $filterInstance An instance of this filter class
50 public static final function createPasswordGuestVerifierFilter () {
52 $filterInstance = new PasswordGuestVerifierFilter();
54 // Return the instance
55 return $filterInstance;
59 * Executes the filter with given request and response objects
61 * @param $requestInstance An instance of a class with an Requestable interface
62 * @param $responseInstance An instance of a class with an Responseable interface
64 * @throws FilterChainException If this filter fails to operate
66 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 $password = $requestInstance->getRequestElement('passwd');
70 // Is the password still not set?
71 if (is_null($password)) {
72 // Not found in form so stop the filtering process
73 $requestInstance->requestIsValid(FALSE);
75 // Add a message to the response
76 $responseInstance->addFatalMessage('password_unset');
79 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
80 } elseif (empty($password)) {
82 $requestInstance->requestIsValid(FALSE);
84 // Add a message to the response
85 $responseInstance->addFatalMessage('password_empty');
88 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);