class_ShipSimuLoginHelper.php

Go to the documentation of this file.

<?php
class ShipSimuLoginHelper extends BaseLoginHelper implements HelpableLogin {
        private $authMethod = "";

        // Exception constants
        const EXCEPTION_INVALID_USER_INSTANCE = 0x190;

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createShipSimuLoginHelper (Requestable $requestInstance) {
                // Get a new instance first
                $helperInstance = new ShipSimuLoginHelper();

                // Get a user instance from registry
                $userInstance = Registry::getRegistry()->getInstance('user');

                // Is this instance valid?
                if (!$userInstance instanceof ManageableAccount) {
                        // Thrown an exception here
                        throw new UserInstanceMissingException (array($helperInstance, 'user'), self::EXCEPTION_INVALID_USER_INSTANCE);
                } // END - if

                // Set default login method from config
                $helperInstance->setDefaultAuthMethod();

                // Set request instance
                $helperInstance->setRequestInstance($requestInstance);

                // Return the prepared instance
                return $helperInstance;
        }

        protected function setDefaultAuthMethod () {
                $this->authMethod = $this->getConfigInstance()->readConfig('auth_method_class');
        }

        public function executeLogin (Responseable $responseInstance) {
                // Get an instance from the login method
                $loginInstance = ObjectFactory::createObjectByName($this->authMethod, array($responseInstance));

                // Set user cookie
                $loginInstance->setUserAuth($this->getRequestInstance()->getRequestElement('username'));

                // Set password cookie
                $loginInstance->setPasswordAuth($this->getRequestInstance()->getRequestElement('pass_hash'));

                // Remember this login instance for later usage
                Registry::getRegistry()->addInstance('login', $loginInstance);
        }
}

//
?>