Source for file User.class.php

Documentation is available at User.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Session
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * User Session Interface
  22.  *
  23.  * @category Gumbo
  24.  * @package Session
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc User Session Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Interface_Session");
  34.  
  35. interface Gumbo_Interface_Session_User extends Gumbo_Interface_Session {
  36.     
  37.     /** ACTION METHODS **/
  38.     /**
  39.      * Loads the User SESSION data
  40.      * The User Session Encrypted String is saved in the following format:
  41.      * session_id||user_id||agent||ip_address||date
  42.      * @postcondition setUser ()
  43.      * @postcondition _setUserLoaded ([true|false])
  44.      */
  45.     public function loadUser ();
  46.     
  47.     
  48.     
  49.     /** MUTATOR METHODS **/
  50.     /**
  51.      * Sets the User Key
  52.      * @param string $key 
  53.      */
  54.     public function setUserKey ($key);
  55.     
  56.     /**
  57.      * Sets the User ID
  58.      * @param int|string$userID 
  59.      */
  60.     public function setUser ($userID);
  61.     
  62.     
  63.     
  64.     /** ACCESSOR METHODS **/
  65.     /**
  66.      * Returns the User Key
  67.      * @return string 
  68.      */
  69.     public function getUserKey ();
  70.     
  71.     /**
  72.      * Returns the User ID
  73.      * @return string|int
  74.      */
  75.     public function getUser ();
  76.     
  77.     /**
  78.      * Returns if the User has been loaded
  79.      * @return bool 
  80.      */
  81.     public function isUserLoaded ();
  82.     
  83. }
  84.  
  85. ?>