3 * A cookie-bases authorization class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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__);
35 $this->removeNumberFormaters();
36 $this->removeSystemArray();
40 * Creates an instance of this class by the given response instance
42 * @param $responseInstance An instance of a Responseable class
43 * @return $loginInstance An instance of this login class
45 public final static function createCookieAuth (Responseable $responseInstance) {
47 $loginInstance = new CookieAuth();
49 // Set the response instance
50 $loginInstance->setResponseInstance($responseInstance);
52 // Return the prepared instance
53 return $loginInstance;
57 * "Setter" for username auth data
59 * @param $userName The username from request we shall set
62 public function setUserAuth ($userName) {
63 $this->getResponseInstance()->addCookie('username', $userName);
67 * "Setter" for password hash auth data
69 * @param $passHash The hashed password from request we shall set
72 public function setPasswordAuth ($passHash) {
73 $this->getResponseInstance()->addCookie('u_hash', $passHash, true);
77 * Getter for user auth cookie
79 * @return $userName Username to get from cookie
81 public function getUserAuth () {
82 // Get the username from cookie
83 $userName = $this->getRequestInstance()->readCookie('username');
85 // Return the username
90 * Getter for password hash auth cookie
92 * @return $passHash Password hash to get from cookie
94 public function getPasswordAuth () {
95 // Get the username from cookie
96 $passHash = $this->getRequestInstance()->readCookie('u_hash');
98 // Return the username
103 * Destroy the authorization data
107 public function destroyAuthData () {
108 // Expire both cookies
109 $this->getResponseInstance()->expireCookie('username');
110 $this->getResponseInstance()->expireCookie('u_hash');
114 * Updates the authorization data and/or sets additional tracking data
116 * @param $requestInstance An instance of a Requestable class
119 public function updateAuthData () {
120 $this->getResponseInstance()->refreshCookie('username');
121 $this->getResponseInstance()->refreshCookie('u_hash');