3 * A filter for detecting email changes
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class EmailChangeFilter extends BaseFilter implements Filterable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this filter class
38 * @return $filterInstance An instance of this filter class
40 public static final function createEmailChangeFilter () {
42 $filterInstance = new EmailChangeFilter();
44 // Return the instance
45 return $filterInstance;
49 * Executes the filter with given request and response objects
51 * @param $requestInstance An instance of a class with an Requestable interface
52 * @param $responseInstance An instance of a class with an Responseable interface
54 * @throws FilterChainException If this filter fails to operate
55 * @todo Implement email change of the user here. HINT: Use the User class!
57 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
59 $email1 = $requestInstance->getRequestElement('email1');
60 $email2 = $requestInstance->getRequestElement('email2');
62 // Is only first email set?
63 if ((!empty($email1)) && (empty($email2))) {
64 // Request is invalid!
65 $requestInstance->requestIsValid(FALSE);
68 $responseInstance->addFatalMessage('email2_empty');
70 // Stop processing here
71 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
74 // Is only second email set?
75 if ((empty($email1)) && (!empty($email2))) {
76 // Request is invalid!
77 $requestInstance->requestIsValid(FALSE);
80 $responseInstance->addFatalMessage('email1_empty');
82 // Stop processing here
83 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
87 if ($email1 != $email2) {
88 // Request is invalid!
89 $requestInstance->requestIsValid(FALSE);
91 // Emails are mismatching
92 $responseInstance->addFatalMessage('emails_mismatch');
94 // Stop processing here
95 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
98 // Are email and confirmation empty?
99 if ((empty($email1)) && (empty($email2))) {
100 // No email change required!
104 // Now, get a user instance for comparison
105 $userInstance = Registry::getRegistry()->getInstance('user');
107 // Get the email field
108 $userEmail = $userInstance->getField('email');
110 // Are they different?
111 if ($userEmail == $email1) {
112 // Nothing has been changed is fine...
116 // Update the "new_email" field
117 $this->partialStub('Unfinished part.');