3 namespace Org\Mxchange\CoreFramework\Filter\Change\Email;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
7 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
8 use Org\Mxchange\CoreFramework\Filter\Filterable;
9 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Response\Responseable;
14 * A filter for detecting email changes
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.shipsimu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 class EmailChangeFilter extends BaseFilter implements Filterable {
37 * Protected constructor
41 private function __construct () {
42 // Call parent constructor
43 parent::__construct(__CLASS__);
47 * Creates an instance of this filter class
49 * @return $filterInstance An instance of this filter class
51 public static final function createEmailChangeFilter () {
53 $filterInstance = new EmailChangeFilter();
55 // Return the instance
56 return $filterInstance;
60 * Executes the filter with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
65 * @throws FilterChainException If this filter fails to operate
66 * @todo Implement email change of the user here. HINT: Use the User class!
68 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
70 $email1 = $requestInstance->getRequestElement('email1');
71 $email2 = $requestInstance->getRequestElement('email2');
73 // Is only first email set?
74 if ((!empty($email1)) && (empty($email2))) {
75 // Request is invalid!
76 $requestInstance->requestIsValid(false);
79 $responseInstance->addFatalMessage('email2_empty');
81 // Stop processing here
82 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
85 // Is only second email set?
86 if ((empty($email1)) && (!empty($email2))) {
87 // Request is invalid!
88 $requestInstance->requestIsValid(false);
91 $responseInstance->addFatalMessage('email1_empty');
93 // Stop processing here
94 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
98 if ($email1 != $email2) {
99 // Request is invalid!
100 $requestInstance->requestIsValid(false);
102 // Emails are mismatching
103 $responseInstance->addFatalMessage('emails_mismatch');
105 // Stop processing here
106 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
109 // Are email and confirmation empty?
110 if ((empty($email1)) && (empty($email2))) {
111 // No email change required!
115 // Now, get a user instance for comparison
116 $userInstance = GenericRegistry::getRegistry()->getInstance('user');
118 // Get the email field
119 $userEmail = $userInstance->getField('email');
121 // Are they different?
122 if ($userEmail == $email1) {
123 // Nothing has been changed is fine...
127 // Update the "new_email" field
128 $this->partialStub('Unfinished part.');