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