inc/main/classes/factories/login/class_LoginFactory.php

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