* filter chain if no username is given or if supplied username has an invalid
* form. It could also intercept our filter chain if username was not found.
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* Creates an instance of this filter class
*
- * @return $filterInstance An instance of this filter class
+ * @return $filterInstance An instance of this filter class
*/
- public final static function createUserNameVerifierFilter () {
+ public static final function createUserNameVerifierFilter () {
// Get a new instance
$filterInstance = new UserNameVerifierFilter();
* @param $requestInstance An instance of a class with an Requestable interface
* @param $responseInstance An instance of a class with an Responseable interface
* @return void
+ * @throws FilterChainException If this filter fails to operate
*/
public function execute (Requestable $requestInstance, Responseable $responseInstance) {
// Get username from request
// Is the username set?
if (is_null($userName)) {
// Not found in form so stop the filtering process
- $requestInstance->requestIsValid(false);
+ $requestInstance->requestIsValid(FALSE);
// Add a message to the response
$responseInstance->addFatalMessage('username_unset');
// Abort here
- return false;
+ throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
} elseif (empty($userName)) {
// Empty field!
- $requestInstance->requestIsValid(false);
+ $requestInstance->requestIsValid(FALSE);
// Add a message to the response
$responseInstance->addFatalMessage('username_empty');
// Abort here
- return false;
- } elseif ($this->ifUserNameIsTaken($userName) === false) {
+ throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
+ } elseif ($this->ifUserNameIsTaken($userName) === FALSE) {
// Username is already taken
- $requestInstance->requestIsValid(false);
+ $requestInstance->requestIsValid(FALSE);
// Add a message to the response
$responseInstance->addFatalMessage('username_not_found');
// Abort here
- return false;
+ throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
}
}
/**
- * Check wether the username as already been taken
+ * Check whether the username as already been taken
*
* @param $userName Username to check for existence
- * @return $alreadyTaken Wether the username has been taken
+ * @return $alreadyTaken Whether the username has been taken
*/
private function ifUserNameIsTaken ($userName) {
// Default is already taken
- $alreadyTaken = true;
+ $alreadyTaken = TRUE;
// Initialize instance
- $userInstance = null;
+ $userInstance = NULL;
// Get a registry instance
$registry = Registry::getRegistry();
// If this instance is created then the username *does* exist
try {
// Get a new instance
- $userInstance = call_user_func_array(array($this->getConfigInstance()->readConfig('user_class'), 'createMemberByUsername'), array($userName));
+ $userInstance = call_user_func_array(array($this->getConfigInstance()->getConfigEntry('user_class'), 'createMemberByUsername'), array($userName));
// Remember this user instance in our registry for later usage
$registry->addInstance('user', $userInstance);
}
// Does the username exist?
- if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === false)) {
+ if ((is_null($userInstance)) || ($userInstance->ifUsernameExists() === FALSE)) {
// This username is still available
- $alreadyTaken = false;
+ $alreadyTaken = FALSE;
} // END - if
// Return the result