Code sync from ship-simu code (all class config entries must end with _class!)
[mailer.git] / inc / classes / main / filter / validator / class_PasswordValidatorFilter.php
1 <?php
2 /**
3  * A concrete filter for validating the password. This filter may intercept
4  * the filter chain if no password is given or if both passwords didn't match.
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
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
11  *
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.
16  *
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.
21  *
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/>.
24  */
25 class PasswordValidatorFilter extends BaseFilter implements Filterable {
26         /**
27          * Protected constructor
28          *
29          * @return      void
30          */
31         protected function __construct () {
32                 // Call parent constructor
33                 parent::__construct(__CLASS__);
34
35                 // Set part description
36                 $this->setObjectDescription("A filter for Password validation");
37
38                 // Create unique ID number
39                 $this->generateUniqueId();
40         }
41
42         /**
43          * Creates an instance of this filter class
44          *
45          * @return      $filterInstance         An instance of this filter class
46          */
47         public final static function createPasswordValidatorFilter () {
48                 // Get a new instance
49                 $filterInstance = new PasswordValidatorFilter();
50
51                 // Return the instance
52                 return $filterInstance;
53         }
54
55         /**
56          * Executes the filter with given request and response objects
57          *
58          * @param       $requestInstance        An instance of a class with an Requestable interface
59          * @param       $responseInstance       An instance of a class with an Responseable interface
60          * @return      void
61          */
62         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
63                 // Get passwords
64                 $password1 = $requestInstance->getRequestElement('pass1');
65                 $password2 = $requestInstance->getRequestElement('pass2');
66
67                 // Is the password still not set?
68                 if ((is_null($password1)) || (is_null($password2))) {
69                         // Not found in form so stop the filtering process
70                         $requestInstance->requestIsValid(false);
71
72                         // Add a message to the response
73                         $responseInstance->addFatalMessage('password_unset');
74
75                         // Abort here
76                         return false;
77                 } elseif ((empty($password1)) || (empty($password2))) {
78                         // Password is empty
79                         $requestInstance->requestIsValid(false);
80
81                         // Is the password empty?
82                         if (empty($password1)) {
83                                 // Add a message to the response
84                                 $responseInstance->addFatalMessage('password1_empty');
85                         } // END - if
86
87                         // Is the confirmation empty?
88                         if (empty($password2)) {
89                                 // Add a message to the response
90                                 $responseInstance->addFatalMessage('password2_empty');
91                         } // END - if
92
93                         // Abort here
94                         return false;
95                 } elseif ($password1 != $password2) {
96                         // Passwords didn't match
97                         $requestInstance->requestIsValid(false);
98
99                         // Add a message to the response
100                         $responseInstance->addFatalMessage('passwords_mismatching');
101
102                         // Abort here
103                         return false;
104                 } // END - elseif
105         }
106 }
107
108 // [EOF]
109 ?>