3 * A concrete filter for validating the username. This filter may intercept the
4 * filter chain if no username is given or if supplied username has an invalid
5 * form. It could also intercept our filter chain if username is already taken.
7 * @author Roland Haeder <webmaster@ship-simu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.ship-simu.org
13 * This program is free software: you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation, either version 3 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 class UserNameValidatorFilter extends BaseFilter implements Filterable {
28 * Protected constructor
32 protected function __construct () {
33 // Call parent constructor
34 parent::__construct(__CLASS__);
38 * Creates an instance of this filter class
40 * @param $controllerInstance An instance of a Controller class
41 * @return $filterInstance An instance of this filter class
43 public final static function createUserNameValidatorFilter (Controller $controllerInstance) {
45 $filterInstance = new UserNameValidatorFilter();
48 $filterInstance->setControllerInstance($controllerInstance);
50 // Return the instance
51 return $filterInstance;
55 * Executes the filter with given request and response objects
57 * @param $requestInstance An instance of a class with an Requestable interface
58 * @param $responseInstance An instance of a class with an Responseable interface
61 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
62 // Get username from request
63 $userName = $requestInstance->getRequestElement('username');
65 // Is the username set?
66 if (is_null($userName)) {
67 // Not found in form so stop the filtering process
68 $requestInstance->requestIsValid(false);
70 // Add a message to the response
71 $responseInstance->addFatalMessage('username_unset');
75 } elseif (empty($userName)) {
77 $requestInstance->requestIsValid(false);
79 // Add a message to the response
80 $responseInstance->addFatalMessage('username_empty');
84 } elseif ($this->ifUserNameIsTaken($userName)) {
85 // Username is already taken
86 $requestInstance->requestIsValid(false);
88 // Add a message to the response
89 $responseInstance->addFatalMessage('username_taken');
97 * Check wether the username as already been taken
99 * @param $userName Username to check for existence
100 * @return $alreadyTaken Wether the username has been taken
102 private function ifUserNameIsTaken ($userName) {
103 // Default is already taken
104 $alreadyTaken = true;
106 // Initialize instance
107 $userInstance = null;
109 // Get a registry instance
110 $registry = Registry::getRegistry();
112 // Is the user already there?
113 if ($registry->instanceExists('user')) {
114 // Use the instance for checking for the email
115 $userInstance = $registry->getInstance('user');
116 $userInstance->setUserName($userName);
118 // If this instance is created then the username *does* exist
120 // Get a new instance
121 $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), 'createMemberByUsername'), array($userName));
123 // Remember this user instance in our registry for later usage
124 $registry->addInstance('user', $userInstance);
125 } catch (UsernameMissingException $e) {
126 // User was not found
130 // Does the username exist?
131 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
132 // This username is still available
133 $alreadyTaken = false;
137 return $alreadyTaken;