3 * A concrete filter for validating the email address. This filter may intercept
4 * the filter chain if no email address is given or if supplied email has an
5 * invalid form. It could also intercept our filter chain if email address is
6 * already used by some one if configuration requires this.
8 * @author Roland Haeder <webmaster@ship-simu.org>
10 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.ship-simu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 class EmailValidatorFilter extends BaseFilter implements Filterable {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
39 * Creates an instance of this filter class
41 * @return $filterInstance An instance of this filter class
43 public final static function createEmailValidatorFilter () {
45 $filterInstance = new EmailValidatorFilter();
47 // Return the instance
48 return $filterInstance;
52 * Executes the filter with given request and response objects
54 * @param $requestInstance An instance of a class with an Requestable interface
55 * @param $responseInstance An instance of a class with an Responseable interface
58 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
59 // Get Email from request
60 $email = $requestInstance->getRequestElement('email');
63 if ((is_null($email)) || ($this->getConfigInstance()->readConfig('register_email_unique') === "Y")) {
65 $email1 = $requestInstance->getRequestElement('email1');
66 $email2 = $requestInstance->getRequestElement('email2');
68 // Is the email still not set?
69 if ((is_null($email1)) || (is_null($email2))) {
70 // Not found in form so stop the filtering process
71 $requestInstance->requestIsValid(false);
73 // Add a message to the response
74 $responseInstance->addFatalMessage('email_unset');
78 } elseif ((empty($email1)) || (empty($email2))) {
80 $requestInstance->requestIsValid(false);
82 // Is the email empty?
84 // Add a message to the response
85 $responseInstance->addFatalMessage('email1_empty');
88 // Is the confirmation empty?
90 // Add a message to the response
91 $responseInstance->addFatalMessage('email2_empty');
96 } elseif ($this->ifEmailIsTaken($email1)) {
97 // Email is already taken
98 $requestInstance->requestIsValid(false);
100 // Add a message to the response
101 $responseInstance->addFatalMessage('email_taken');
105 } elseif ($email1 != $email2) {
106 // Emails didn't match
107 $requestInstance->requestIsValid(false);
109 // Add a message to the response
110 $responseInstance->addFatalMessage('emails_mismatch');
115 } elseif (empty($email)) {
117 $requestInstance->requestIsValid(false);
119 // Add a message to the response
120 $responseInstance->addFatalMessage('email_empty');
128 * Check wether the email as already been taken
130 * @param $email Email to check for existence
131 * @return $alreadyTaken Wether the email has been taken
133 private function ifEmailIsTaken ($email) {
134 // Default is already taken
135 $alreadyTaken = true;
137 // Initialize instance
138 $userInstance = null;
140 // Get a registry instance
141 $registry = Registry::getRegistry();
143 // Is the user already there?
144 if ($registry->instanceExists('user')) {
145 // Use the instance for checking for the email
146 $userInstance = $registry->getInstance('user');
147 $userInstance->setEmailAddress($email);
149 // If this instance is created then the username *does* exist
150 $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), 'createMemberByEmail'), array($email));
152 // Remember this user instance in our registry for later usage
153 $registry->addInstance('user', $userInstance);
156 // Does the email exist?
157 if ($userInstance->ifEmailAddressExists() === false) {
158 // This email has not being used yet
159 $alreadyTaken = false;
163 return $alreadyTaken;