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