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\Filterable;
8 use Org\Mxchange\CoreFramework\Registry\Registry;
9 use Org\Mxchange\CoreFramework\Request\Requestable;
10 use Org\Mxchange\CoreFramework\Response\Responseable;
13 * A filter for detecting email changes
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 <<<<<<< HEAD:framework/main/classes/filter/change/class_EmailChangeFilter.php
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
21 >>>>>>> Some updates::inc/main/classes/filter/change/class_EmailChangeFilter.php
22 * @license GNU GPL 3.0 or any newer version
23 * @link http://www.shipsimu.org
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class EmailChangeFilter extends BaseFilter implements Filterable {
40 * Protected constructor
44 protected function __construct () {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
50 * Creates an instance of this filter class
52 * @return $filterInstance An instance of this filter class
54 public static final function createEmailChangeFilter () {
56 $filterInstance = new EmailChangeFilter();
58 // Return the instance
59 return $filterInstance;
63 * Executes the filter with given request and response objects
65 * @param $requestInstance An instance of a class with an Requestable interface
66 * @param $responseInstance An instance of a class with an Responseable interface
68 * @throws FilterChainException If this filter fails to operate
69 * @todo Implement email change of the user here. HINT: Use the User class!
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 $email1 = $requestInstance->getRequestElement('email1');
74 $email2 = $requestInstance->getRequestElement('email2');
76 // Is only first email set?
77 if ((!empty($email1)) && (empty($email2))) {
78 // Request is invalid!
79 $requestInstance->requestIsValid(false);
82 $responseInstance->addFatalMessage('email2_empty');
84 // Stop processing here
85 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
88 // Is only second email set?
89 if ((empty($email1)) && (!empty($email2))) {
90 // Request is invalid!
91 $requestInstance->requestIsValid(false);
94 $responseInstance->addFatalMessage('email1_empty');
96 // Stop processing here
97 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
101 if ($email1 != $email2) {
102 // Request is invalid!
103 $requestInstance->requestIsValid(false);
105 // Emails are mismatching
106 $responseInstance->addFatalMessage('emails_mismatch');
108 // Stop processing here
109 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
112 // Are email and confirmation empty?
113 if ((empty($email1)) && (empty($email2))) {
114 // No email change required!
118 // Now, get a user instance for comparison
119 $userInstance = Registry::getRegistry()->getInstance('user');
121 // Get the email field
122 $userEmail = $userInstance->getField('email');
124 // Are they different?
125 if ($userEmail == $email1) {
126 // Nothing has been changed is fine...
130 // Update the "new_email" field
131 $this->partialStub('Unfinished part.');