3 * A cookie-bases authorization class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class CookieAuth extends BaseFrameworkSystem implements Authorizeable, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class by the given response instance
38 * @param $responseInstance An instance of a Responseable class
39 * @return $loginInstance An instance of this login class
41 public static final function createCookieAuth (Responseable $responseInstance) {
43 $loginInstance = new CookieAuth();
45 // Set the response instance
46 $loginInstance->setResponseInstance($responseInstance);
48 // Return the prepared instance
49 return $loginInstance;
53 * "Setter" for username auth data
55 * @param $userName The username from request we shall set
58 public function setUserAuth ($userName) {
59 $this->getResponseInstance()->addCookie('username', $userName);
63 * "Setter" for password hash auth data
65 * @param $passHash The hashed password from request we shall set
68 public function setPasswordAuth ($passHash) {
69 $this->getResponseInstance()->addCookie('u_hash', $passHash);
73 * Getter for user auth cookie
75 * @return $userName Username to get from cookie
77 public function getUserAuth () {
78 // Get the username from cookie
79 $userName = $this->getRequestInstance()->readCookie('username');
81 // Return the username
86 * Getter for password hash auth cookie
88 * @return $passHash Password hash to get from cookie
90 public function getPasswordAuth () {
91 // Get the username from cookie
92 $passHash = $this->getRequestInstance()->readCookie('u_hash');
94 // Return the username
99 * Destroy the authorization data
103 public function destroyAuthData () {
104 // Expire both cookies
105 $this->getResponseInstance()->expireCookie('username');
106 $this->getResponseInstance()->expireCookie('u_hash');
110 * Updates the authorization data and/or sets additional tracking data
112 * @param $requestInstance An instance of a Requestable class
115 public function updateAuthData () {
116 $this->getResponseInstance()->refreshCookie('username');
117 $this->getResponseInstance()->refreshCookie('u_hash');