inc/classes/main/login/class_CookieLogin.php

   1 <?php
   2 /**
   3  * A cookie-bases login class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class CookieLogin extends BaseFrameworkSystem implements Registerable {
  25         /**
  26          * Response instance
  27          */
  28         private $responseInstance = null;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set part description
  40                 $this->setObjectDescription("Cookie-based login");
  41
  42                 // Create unique ID number
  43                 $this->generateUniqueId();
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47                 $this->removeSystemArray();
  48         }
  49
  50         /**
  51          * Creates an instance of this class by the given response instance
  52          *
  53          * @param       $responseInstance       An instance of a Responseable class
  54          * @return      $loginInstance          An instance of this login class
  55          */
  56         public final static function createCookieLogin (Responseable $responseInstance) {
  57                 // Get a new instance
  58                 $loginInstance = new CookieLogin();
  59
  60                 // Set the response instance
  61                 $loginInstance->setResponseInstance($responseInstance);
  62
  63                 // Return the prepared instance
  64                 return $loginInstance;
  65         }
  66
  67         /**
  68          * Setter for login instance
  69          *
  70          * @param       $responseInstance       An instance of a Responseable class
  71          * @return      void
  72          */
  73         protected final function setResponseInstance (Responseable $responseInstance) {
  74                 $this->responseInstance = $responseInstance;
  75         }
  76
  77         /**
  78          * "Setter" for username auth data
  79          *
  80          * @param       $userName       The username from request we shall set
  81          * @return      void
  82          */
  83         public function setUserAuth ($userName) {
  84                 $this->responseInstance->addCookie('username', $userName);
  85         }
  86
  87         /**
  88          * "Setter" for password hash auth data
  89          *
  90          * @param       $passHash       The hashed password from request we shall set
  91          * @return      void
  92          */
  93         public function setPasswordAuth ($passHash) {
  94                 $this->responseInstance->addCookie('u_hash', $passHash, true);
  95         }
  96 }
  97
  98 // [EOF]
  99 ?>