inc/main/classes/factories/user/class_UserFactory.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory\User;
   4
   5 // Import framework stuff
   6 use CoreFramework\Configuration\FrameworkConfiguration;
   7 use CoreFramework\Registry\Generic\Registry;
   8
   9 /**
  10  * A factory class for socket registries
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class UserFactory extends ObjectFactory {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Returns a singleton user instance for given request instance.
  44          *
  45          * @param       $requestInstance        An instance of a Requestable class
  46          * @return      $userInstance           An instance of a user class (@TODO use actual interface name)
  47          */
  48         public static final function createUserByRequest (Requestable $requestInstance) {
  49                 // Get registry instance
  50                 $registryInstance = Registry::getRegistry();
  51
  52                 // Do we have an instance in the registry?
  53                 if ($registryInstance->instanceExists('user')) {
  54                         // Then use this instance
  55                         $userInstance = $registryInstance->getInstance('user');
  56                 } else {
  57                         // Probe on member instance
  58                         try {
  59                                 // Get class name
  60                                 $className = FrameworkConfiguration::getSelfInstance()->getConfigEntry('user_class');
  61
  62                                 // Try to instance it
  63                                 $userInstance = call_user_func_array(array($className, 'createMemberByRequest'), array($requestInstance));
  64                         } catch (UnexpectedGuestAccountException $e) {
  65                                 // Then try it with guest account
  66                                 $className = FrameworkConfiguration::getSelfInstance()->getConfigEntry('guest_class');
  67
  68                                 // Try to instance it
  69                                 $userInstance = call_user_func_array(array($className, 'createGuestByRequest'), array($requestInstance));
  70                         }
  71
  72                         // Set the instance in registry for further use
  73                         $registryInstance->addInstance('user', $userInstance);
  74                 }
  75
  76                 // Return the instance
  77                 return $userInstance;
  78         }
  79
  80 }