application/city/classes/login/helper/class_CityLoginHelper.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Helper\Login;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   8 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
   9 use Org\Mxchange\CoreFramework\Request\Requestable;
  10
  11 /**
  12  * A helper for City to login. This login helper first checks what setting
  13  * (cookie or session) the admin has choosen then overwrites it with the setting
  14  * from current user. The registry instance should hold an instance of this user
  15  * class at key 'user' else an exception will be thrown. After this the setting
  16  * from a login form will be taken as login method and be stored in database
  17  * for later usage.
  18  *
  19  * The user shall be able to choose "Default login method" or similar to use his
  20  * own login method.
  21  *
  22  * @author              Roland Haeder <webmaster@shipsimu.org>
  23  * @version             0.0.0
  24  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  25  * @license             GNU GPL 3.0 or any newer version
  26  * @link                http://www.shipsimu.org
  27  *
  28  * This program is free software: you can redistribute it and/or modify
  29  * it under the terms of the GNU General Public License as published by
  30  * the Free Software Foundation, either version 3 of the License, or
  31  * (at your option) any later version.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 class CityLoginHelper extends BaseLoginHelper implements HelpableLogin {
  42         /**
  43          * The login method we shall choose
  44          */
  45         private $authMethod = '';
  46
  47         // Exception constants
  48         const EXCEPTION_INVALID_USER_INSTANCE = 0x190;
  49
  50         /**
  51          * Protected constructor
  52          *
  53          * @return      void
  54          */
  55         protected function __construct () {
  56                 // Call parent constructor
  57                 parent::__construct(__CLASS__);
  58         }
  59
  60         /**
  61          * Creates an instance of this class by given request instance
  62          *
  63          * @param       $requestInstance        An instance of a Requestable class
  64          * @return      $helperInstance         An instance of this helper class
  65          * @throws      UserInstanceMissingException    If the user instance in registry
  66          *                                                                                      is missing or invalid
  67          */
  68         public static final function createCityLoginHelper (Requestable $requestInstance) {
  69                 // Get a new instance first
  70                 $helperInstance = new CityLoginHelper();
  71
  72                 // Get a user instance from registry
  73                 $userInstance = GenericRegistry::getRegistry()->getInstance('user');
  74
  75                 // Is this instance valid?
  76                 if (!$userInstance instanceof ManageableAccount) {
  77                         // Thrown an exception here
  78                         throw new UserInstanceMissingException (array($helperInstance, 'user'), self::EXCEPTION_INVALID_USER_INSTANCE);
  79                 } // END - if
  80
  81                 // Set default login method from config
  82                 $helperInstance->setDefaultAuthMethod();
  83
  84                 // Return the prepared instance
  85                 return $helperInstance;
  86         }
  87
  88         /**
  89          * Setter for default login method from config
  90          *
  91          * @return      void
  92          */
  93         protected function setDefaultAuthMethod () {
  94                 $this->authMethod = $this->getConfigInstance()->getConfigEntry('auth_method_class');
  95         }
  96
  97         /**
  98          * Execute the login request by given response instance. This instance can
  99          * be used for sending cookies or at least the session id out.
 100          *
 101          * @param       $responseInstance       An instance of a Responseable class
 102          * @return      void
 103          */
 104         public function executeLogin (Responseable $responseInstance) {
 105                 // Get an instance from the login method
 106                 $loginInstance = ObjectFactory::createObjectByName($this->authMethod, array($responseInstance));
 107
 108                 // Set user cookie
 109                 $loginInstance->setUserAuth(FrameworkBootstrap::getRequestInstance()->getRequestElement('username'));
 110
 111                 // Set password cookie
 112                 $loginInstance->setPasswordAuth(FrameworkBootstrap::getRequestInstance()->getRequestElement('pass_hash'));
 113
 114                 // Remember this login instance for later usage
 115                 GenericRegistry::getRegistry()->addInstance('login', $loginInstance);
 116         }
 117 }