3 namespace CoreFramework\Filter\Change\Email;
5 // Import framework stuff
6 use CoreFramework\Filter\BaseFilter;
7 use CoreFramework\Filter\Filterable;
8 use CoreFramework\Registry\Registry;
9 use CoreFramework\Request\Requestable;
10 use CoreFramework\Response\Responseable;
13 * A filter for detecting email changes
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class EmailChangeFilter extends BaseFilter implements Filterable {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this filter class
48 * @return $filterInstance An instance of this filter class
50 public static final function createEmailChangeFilter () {
52 $filterInstance = new EmailChangeFilter();
54 // Return the instance
55 return $filterInstance;
59 * Executes the filter with given request and response objects
61 * @param $requestInstance An instance of a class with an Requestable interface
62 * @param $responseInstance An instance of a class with an Responseable interface
64 * @throws FilterChainException If this filter fails to operate
65 * @todo Implement email change of the user here. HINT: Use the User class!
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
69 $email1 = $requestInstance->getRequestElement('email1');
70 $email2 = $requestInstance->getRequestElement('email2');
72 // Is only first email set?
73 if ((!empty($email1)) && (empty($email2))) {
74 // Request is invalid!
75 $requestInstance->requestIsValid(FALSE);
78 $responseInstance->addFatalMessage('email2_empty');
80 // Stop processing here
81 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
84 // Is only second email set?
85 if ((empty($email1)) && (!empty($email2))) {
86 // Request is invalid!
87 $requestInstance->requestIsValid(FALSE);
90 $responseInstance->addFatalMessage('email1_empty');
92 // Stop processing here
93 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
97 if ($email1 != $email2) {
98 // Request is invalid!
99 $requestInstance->requestIsValid(FALSE);
101 // Emails are mismatching
102 $responseInstance->addFatalMessage('emails_mismatch');
104 // Stop processing here
105 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
108 // Are email and confirmation empty?
109 if ((empty($email1)) && (empty($email2))) {
110 // No email change required!
114 // Now, get a user instance for comparison
115 $userInstance = Registry::getRegistry()->getInstance('user');
117 // Get the email field
118 $userEmail = $userInstance->getField('email');
120 // Are they different?
121 if ($userEmail == $email1) {
122 // Nothing has been changed is fine...
126 // Update the "new_email" field
127 $this->partialStub('Unfinished part.');