inc/classes/main/filter/validator/class_UserNameValidatorFilter.php

   1 <?php
   2 /**
   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
   6  * already taken.
   7  *
   8  * @author              Roland Haeder <webmaster@ship-simu.org>
   9  * @version             0.0.0
  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
  13  *
  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.
  18  *
  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.
  23  *
  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/>.
  26  */
  27 class UserNameValidatorFilter extends BaseFrameworkSystem implements Filterable {
  28         /**
  29          * Private constructor
  30          *
  31          * @return      void
  32          */
  33         protected function __construct () {
  34                 // Call parent constructor
  35                 parent::__construct(__CLASS__);
  36
  37                 // Set part description
  38                 $this->setObjectDescription("A filter for username validation");
  39
  40                 // Create unique ID number
  41                 $this->createUniqueID();
  42
  43                 // Clean up a little
  44                 $this->removeNumberFormaters();
  45                 $this->removeSystemArray();
  46         }
  47
  48         /**
  49          * Creates an instance of this filter class
  50          *
  51          * @return      $filterInstance         An instance of this filter class
  52          */
  53         public final static function createUserNameValidatorFilter () {
  54                 // Get a new instance
  55                 $filterInstance = new UserNameValidatorFilter();
  56
  57                 // Return the instance
  58                 return $filterInstance;
  59         }
  60
  61         /**
  62          * Executes the filter with given request and response objects
  63          *
  64          * @param       $requestInstance        An instance of a class with an Requestable interface
  65          * @param       $responseInstance       An instance of a class with an Responseable interface
  66          * @return      void
  67          */
  68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Get username from request
  70                 $userName = $requestInstance->getRequestElement('username');
  71
  72                 // Is the username set?
  73                 if (is_null($userName)) {
  74                         // Not found in form so stop the filtering process
  75                         $requestInstance->requestIsValid(false);
  76
  77                         // Set a message for the response
  78                         $responseInstance->addFatalMessage('username_unset');
  79
  80                         // Abort here
  81                         return false;
  82                 } elseif (empty($userName)) {
  83                         // Empty field!
  84                         $requestInstance->requestIsValid(false);
  85
  86                         // Set a message for the response
  87                         $responseInstance->addFatalMessage('username_empty');
  88
  89                         // Abort here
  90                         return false;
  91                 } elseif ($this->ifUserNameIsTaken($userName)) {
  92                         // Username is already taken
  93                         $requestInstance->requestIsValid(false);
  94
  95                         // Set a message for the response
  96                         $responseInstance->addFatalMessage('username_taken');
  97
  98                         // Abort here
  99                         return false;
 100                 }
 101         }
 102
 103         /**
 104          * Check wether the username as already been taken
 105          *
 106          * @param       $userName               Username to check for existence
 107          * @return      $alreadyTaken   Wether the username has been taken
 108          */
 109         private function ifUserNameIsTaken ($userName) {
 110                 // Default is already taken
 111                 $alreadyTaken = true;
 112
 113                 // Try to create a user instance
 114                 try {
 115                         // If this instance is created then the username *does* exist
 116                         $userInstance = User::createUserByUsername($userName);
 117                 } catch (UsernameMissingException $e) {
 118                         // Okay, this user is missing!
 119                         $alreadyTaken = false;
 120                 }
 121
 122                 // Return the result
 123                 return $alreadyTaken;
 124         }
 125 }
 126
 127 // [EOF]
 128 ?>