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