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