3 * A concrete filter for validating the username. This filter may intercept the
4 * filter chain if no username is given or if the supplied username has an
5 * invalid form. It could also intercept the filter chain if the username is
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 UserNameValidatorFilter 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 createUserNameValidatorFilter () {
45 $filterInstance = new UserNameValidatorFilter();
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 username from request
60 $userName = $requestInstance->getRequestElement('username');
62 // Is the username set?
63 if (is_null($userName)) {
64 // Not found in form so stop the filtering process
65 $requestInstance->requestIsValid(false);
67 // Add a message to the response
68 $responseInstance->addFatalMessage('username_unset');
72 } elseif (empty($userName)) {
74 $requestInstance->requestIsValid(false);
76 // Add a message to the response
77 $responseInstance->addFatalMessage('username_empty');
81 } elseif ($this->ifUserNameIsTaken($userName)) {
82 // Username is already taken
83 $requestInstance->requestIsValid(false);
85 // Add a message to the response
86 $responseInstance->addFatalMessage('username_taken');
94 * Check wether the username as already been taken
96 * @param $userName Username to check for existence
97 * @return $alreadyTaken Wether the username has been taken
99 private function ifUserNameIsTaken ($userName) {
100 // Default is already taken
101 $alreadyTaken = true;
103 // Initialize instance
104 $userInstance = null;
106 // Get a registry instance
107 $registry = Registry::getRegistry();
109 // Is the user already there?
110 if ($registry->instanceExists('user')) {
111 // Use the instance for checking for the email
112 $userInstance = $registry->getInstance('user');
113 $userInstance->setUserName($userName);
115 // If this instance is created then the username *does* exist
117 // Get a new instance
118 $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), 'createMemberByUsername'), array($userName));
120 // Remember this user instance in our registry for later usage
121 $registry->addInstance('user', $userInstance);
122 } catch (UsernameMissingException $e) {
123 // User was not found
127 // Does the username exist?
128 if ((is_null($userInstance)) || (!$userInstance->ifUsernameExists())) {
129 // This username is still available
130 $alreadyTaken = false;
134 return $alreadyTaken;