21d0941ee982b44e40af4d23a9f977eb6dfa2af2
[shipsimu.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 BaseFrameworkSystem 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->createUniqueID();
40
41                 // Clean up a little
42                 $this->removeNumberFormaters();
43                 $this->removeSystemArray();
44         }
45
46         /**
47          * Creates an instance of this filter class
48          *
49          * @return      $filterInstance         An instance of this filter class
50          */
51         public final static function createPasswordValidatorFilter () {
52                 // Get a new instance
53                 $filterInstance = new PasswordValidatorFilter();
54
55                 // Return the instance
56                 return $filterInstance;
57         }
58
59         /**
60          * Executes the filter with given request and response objects
61          *
62          * @param       $requestInstance        An instance of a class with an Requestable interface
63          * @param       $responseInstance       An instance of a class with an Responseable interface
64          * @return      void
65          */
66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
67                 // Get passwords
68                 $password1 = $requestInstance->getRequestElement('pass1');
69                 $password2 = $requestInstance->getRequestElement('pass2');
70
71                 // Is the password still not set?
72                 if ((is_null($password1)) || (is_null($password2))) {
73                         // Not found in form so stop the filtering process
74                         $requestInstance->requestIsValid(false);
75
76                         // Add a message to the response
77                         $responseInstance->addFatalMessage('password_unset');
78
79                         // Abort here
80                         return false;
81                 } elseif ((empty($password1)) || (empty($password2))) {
82                         // Password is empty
83                         $requestInstance->requestIsValid(false);
84
85                         // Is the password empty?
86                         if (empty($password1)) {
87                                 // Add a message to the response
88                                 $responseInstance->addFatalMessage('password1_empty');
89                         } // END - if
90
91                         // Is the confirmation empty?
92                         if (empty($password2)) {
93                                 // Add a message to the response
94                                 $responseInstance->addFatalMessage('password2_empty');
95                         } // END - if
96
97                         // Abort here
98                         return false;
99                 } elseif ($password1 != $password2) {
100                         // Passwords didn't match
101                         $requestInstance->requestIsValid(false);
102
103                         // Add a message to the response
104                         $responseInstance->addFatalMessage('passwords_mismatching');
105
106                         // Abort here
107                         return false;
108                 } // END - elseif
109         }
110 }
111
112 // [EOF]
113 ?>