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