inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database client for the User class
   4  *
   5  * @see                 DatabaseFrontendInterface - An interface for database frontends (front-end to the application)
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class UserDatabaseWrapper extends BaseDatabaseWrapper {
  26         // Constants
  27         const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0xe00;
  28
  29         /**
  30          * Protected constructor
  31          *
  32          * @return      void
  33          */
  34         protected function __construct() {
  35                 // Call parent constructor
  36                 parent::__construct(__CLASS__);
  37
  38                 // Set part description
  39                 $this->setObjectDescription("Database client for user objects");
  40
  41                 // Create unique ID number
  42                 $this->createUniqueID();
  43         }
  44
  45         /**
  46          * Creates an instance of this database client by a provided user class
  47          *
  48          * @param       $userInstance           An instance of a user class
  49          * @return      $clientInstance         An instance of the created client class
  50          * @throws      WrapperUserNameNotFoundException                If the supplied username
  51          *                                                                                              does not exist
  52          */
  53         public final static function createUserDatabaseWrapper (ManageableUser $userInstance) {
  54                 // Get a new instance
  55                 $clientInstance = new UserDatabaseWrapper();
  56
  57                 // Does the username exists?
  58                 if (!$clientInstance->ifUserNameExists($userInstance->getUserName())) {
  59                         // Throw an exception here
  60                         throw new WrapperUserNameNotFoundException (array($clientInstance, $userInstance), self::EXCEPTION_CLIENT_USERNAME_NOT_FOUND);
  61                 }
  62
  63                 // The user exists
  64                 $clientInstance->partialStub("Add loading of full user details");
  65
  66                 // Return the instance
  67                 return $clientInstance;
  68         }
  69 }
  70
  71 // [EOF]
  72 ?>