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__);
34 // Set part description
35 $this->setObjectDescription("Cookie-based login");
37 // Create unique ID number
38 $this->generateUniqueId();
41 $this->removeNumberFormaters();
42 $this->removeSystemArray();
46 * Creates an instance of this class by the given response instance
48 * @param $responseInstance An instance of a Responseable class
49 * @return $loginInstance An instance of this login class
51 public final static function createCookieAuth (Responseable $responseInstance) {
53 $loginInstance = new CookieAuth();
55 // Set the response instance
56 $loginInstance->setResponseInstance($responseInstance);
58 // Return the prepared instance
59 return $loginInstance;
63 * "Setter" for username auth data
65 * @param $userName The username from request we shall set
68 public function setUserAuth ($userName) {
69 $this->getResponseInstance()->addCookie('username', $userName);
73 * "Setter" for password hash auth data
75 * @param $passHash The hashed password from request we shall set
78 public function setPasswordAuth ($passHash) {
79 $this->getResponseInstance()->addCookie('u_hash', $passHash, true);
83 * Getter for user auth cookie
85 * @return $userName Username to get from cookie
87 public function getUserAuth () {
88 // Get the username from cookie
89 $userName = $this->getRequestInstance()->readCookie('username');
91 // Return the username
96 * Getter for password hash auth cookie
98 * @return $passHash Password hash to get from cookie
100 public function getPasswordAuth () {
101 // Get the username from cookie
102 $passHash = $this->getRequestInstance()->readCookie('u_hash');
104 // Return the username
109 * Destroy the authorization data
113 public function destroyAuthData () {
114 // Expire both cookies
115 $this->getResponseInstance()->expireCookie('username');
116 $this->getResponseInstance()->expireCookie('u_hash');
120 * Updates the authorization data and/or sets additional tracking data
122 * @param $requestInstance An instance of a Requestable class
125 public function updateAuthData () {
126 $this->getResponseInstance()->refreshCookie('username');
127 $this->getResponseInstance()->refreshCookie('u_hash');