Method redirectToConfiguredUrl() does now append the suffix '_url' to all config...
[core.git] / inc / classes / main / filter / change / class_EmailChangeFilter.php
1 <?php
2 /**
3  * A filter for detecting email changes
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class EmailChangeFilter extends BaseFilter implements Filterable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this filter class
37          *
38          * @return      $filterInstance                 An instance of this filter class
39          */
40         public final static function createEmailChangeFilter () {
41                 // Get a new instance
42                 $filterInstance = new EmailChangeFilter();
43
44                 // Return the instance
45                 return $filterInstance;
46         }
47
48         /**
49          * Executes the filter with given request and response objects
50          *
51          * @param       $requestInstance        An instance of a class with an Requestable interface
52          * @param       $responseInstance       An instance of a class with an Responseable interface
53          * @return      void
54          * @todo        Implement email change of the user here. HINT: Use the User class!
55          */
56         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
57                 // Get both emails
58                 $email1 = $requestInstance->getRequestElement('email1');
59                 $email2 = $requestInstance->getRequestElement('email2');
60
61                 // Is only first email set?
62                 if ((!empty($email1)) && (empty($email2))) {
63                         // Request is invalid!
64                         $requestInstance->requestIsValid(false);
65
66                         // Email 2 is empty
67                         $responseInstance->addFatalMessage('email2_empty');
68
69                         // Stop processing here
70                         return false;
71                 } // END - if
72
73                 // Is only second email set?
74                 if ((empty($email1)) && (!empty($email2))) {
75                         // Request is invalid!
76                         $requestInstance->requestIsValid(false);
77
78                         // Email 1 is empty
79                         $responseInstance->addFatalMessage('email1_empty');
80
81                         // Stop processing here
82                         return false;
83                 } // END - if
84
85                 // Do both match?
86                 if ($email1 != $email2) {
87                         // Request is invalid!
88                         $requestInstance->requestIsValid(false);
89
90                         // Emails are mismatching
91                         $responseInstance->addFatalMessage('emails_mismatch');
92
93                         // Stop processing here
94                         return false;
95                 } // END - if
96
97                 // Are email and confirmation empty?
98                 if ((empty($email1)) && (empty($email2))) {
99                         // No email change required!
100                         return true;
101                 } // END - if
102
103                 // Now, get a user instance for comparison
104                 $userInstance = Registry::getRegistry()->getInstance('user');
105
106                 // Get the email field
107                 $userEmail = $userInstance->getField('email');
108
109                 // Are they different?
110                 if ($userEmail == $email1) {
111                         // Nothing has been changed is fine...
112                         return true;
113                 } // END - if
114
115                 // Update the "new_email" field
116                 $this->partialStub("Unfinished part.");
117         }
118 }
119
120 // [EOF]
121 ?>