3 * A concrete filter for validating the password. This filter may intercept
4 * the filter chain if no password is given or the password is invalid
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class PasswordVerifierFilter extends BaseFilter implements Filterable {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
35 // Set part description
36 $this->setObjectDescription("A filter for password verification");
38 // Create unique ID number
39 $this->generateUniqueId();
43 * Creates an instance of this filter class
45 * @return $filterInstance An instance of this filter class
47 public final static function createPasswordVerifierFilter () {
49 $filterInstance = new PasswordVerifierFilter();
51 // Return the instance
52 return $filterInstance;
56 * Executes the filter with given request and response objects
58 * @param $requestInstance An instance of a class with an Requestable interface
59 * @param $responseInstance An instance of a class with an Responseable interface
62 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
64 $password = $requestInstance->getRequestElement('pass');
66 // Is the password still not set?
67 if (is_null($password)) {
68 // Not found in form so stop the filtering process
69 $requestInstance->requestIsValid(false);
71 // Add a message to the response
72 $responseInstance->addFatalMessage('password_unset');
76 } elseif (empty($password)) {
78 $requestInstance->requestIsValid(false);
80 // Add a message to the response
81 $responseInstance->addFatalMessage('password_empty');