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

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