3 * A helper for Ship-Simu to login. This login helper first checks what setting
4 * (cookie or session) the admin has choosen then overwrites it with the setting
5 * from current user. The registry instance should hold an instance of this user
6 * class at key 'user' else an exception will be thrown. After this the setting
7 * from a login form will be taken as login method and be stored in database
10 * The user shall be able to choose "Default login method" or similar to use his
13 * @author Roland Haeder <webmaster@ship-simu.org>
15 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.ship-simu.org
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.
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.
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/>.
32 class ShipSimuLoginHelper extends BaseLoginHelper implements HelpableLogin {
34 * The login method we shall choose
36 private $authMethod = "";
39 * Instance for a request class
41 private $requestInstance = null;
43 // Exception constants
44 const EXCEPTION_INVALID_USER_INSTANCE = 0x080;
47 * Protected constructor
51 protected function __construct () {
52 // Call parent constructor
53 parent::__construct(__CLASS__);
55 // Set part description
56 $this->setObjectDescription("Login helper for Ship-Simu");
58 // Create unique ID number
59 $this->generateUniqueId();
63 * Creates an instance of this class by given request instance
65 * @param $requestInstance An instance of a Requestable class
66 * @return $helperInstance An instance of this helper class
67 * @throws UserInstanceMissingException If the user instance in registry
68 * is missing or invalid
70 public final static function createShipSimuLoginHelper (Requestable $requestInstance) {
71 // Get a new instance first
72 $helperInstance = new ShipSimuLoginHelper();
74 // Get a user instance from registry
75 $userInstance = Registry::getRegistry()->getInstance('user');
77 // Is this instance valid?
78 if (!$userInstance instanceof ManageableUser) {
79 // Thrown an exception here
80 throw new UserInstanceMissingException (array($helperInstance, 'user'), self::EXCEPTION_INVALID_USER_INSTANCE);
83 // Set default login method from config
84 $helperInstance->setDefaultAuthMethod();
86 // Set request instance
87 $helperInstance->setRequestInstance($requestInstance);
89 // Return the prepared instance
90 return $helperInstance;
94 * Setter for default login method from config
98 protected function setDefaultAuthMethod () {
99 $this->authMethod = $this->getConfigInstance()->readConfig('auth_method_class');
103 * Setter for request instance
105 * @param $requestInstance A Requestable class instance
108 public final function setRequestInstance (Requestable $requestInstance) {
109 $this->requestInstance = $requestInstance;
113 * Getter for request instance
116 * @return $requestInstance A Requestable class instance
118 public final function getRequestInstance () {
119 return $this->requestInstance;
123 * Execute the login request by given response instance. This instance can
124 * be used for sending cookies or at least the session id out.
126 * @param $responseInstance An instance of a Responseable class
129 public function executeLogin (Responseable $responseInstance) {
130 // Get an instance from the login method
131 $loginInstance = ObjectFactory::createObjectByName($this->authMethod, array($responseInstance));
134 $loginInstance->setUserAuth($this->requestInstance->getRequestElement('username'));
136 // Set password cookie
137 $loginInstance->setPasswordAuth($this->requestInstance->getRequestElement('pass_hash'));
139 // Remember this login instance for later usage
140 Registry::getRegistry()->addInstance('login', $loginInstance);