3 namespace CoreFramework\Filter\Validator\Username;
5 // Import framework stuff
6 use CoreFramework\Registry\Generic\Registry;
9 * A concrete filter for validating the username. This filter may intercept the
10 * filter chain if no username is given or if supplied username has an invalid
11 * form. It could also intercept our filter chain if username is already taken.
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class UserNameValidatorFilter extends BaseFilter implements Filterable {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this filter class
46 * @return $filterInstance An instance of this filter class
48 public static final function createUserNameValidatorFilter () {
50 $filterInstance = new UserNameValidatorFilter();
52 // Return the instance
53 return $filterInstance;
57 * Executes the filter with given request and response objects
59 * @param $requestInstance An instance of a class with an Requestable interface
60 * @param $responseInstance An instance of a class with an Responseable interface
62 * @throws FilterChainException If this filter fails to operate
64 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
65 // Get username from request
66 $userName = $requestInstance->getRequestElement('username');
68 // Is the username set?
69 if (is_null($userName)) {
70 // Not found in form so stop the filtering process
71 $requestInstance->requestIsValid(FALSE);
73 // Add a message to the response
74 $responseInstance->addFatalMessage('username_unset');
77 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
78 } elseif (empty($userName)) {
80 $requestInstance->requestIsValid(FALSE);
82 // Add a message to the response
83 $responseInstance->addFatalMessage('username_empty');
86 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
87 } elseif ($this->ifUserNameIsTaken($userName)) {
88 // Username is already taken
89 $requestInstance->requestIsValid(FALSE);
91 // Add a message to the response
92 $responseInstance->addFatalMessage('username_taken');
95 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
100 * Check whether the username as already been taken
102 * @param $userName Username to check for existence
103 * @return $alreadyTaken Whether the username has been taken
105 private function ifUserNameIsTaken ($userName) {
106 // Default is already taken
107 $alreadyTaken = TRUE;
109 // Initialize instance
110 $userInstance = NULL;
112 // Get a registry instance
113 $registry = Registry::getRegistry();
115 // Is the user already there?
116 if ($registry->instanceExists('user')) {
117 // Use the instance for checking for the email
118 $userInstance = $registry->getInstance('user');
119 $userInstance->setUserName($userName);
121 // If this instance is created then the username *does* exist
123 // Get a new instance
124 $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('user_class'), 'createMemberByUsername'), array($userName));
126 // Remember this user instance in our registry for later usage
127 $registry->addInstance('user', $userInstance);
128 } catch (UsernameMissingException $e) {
129 // User was not found
133 // Does the username exist?
134 if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === FALSE)) {
135 // This username is still available
136 $alreadyTaken = FALSE;
140 return $alreadyTaken;