Gumbo_Session_User

Gumbo_Session_Basic
   |
   --Gumbo_Session_Encrypt
      |
      --Gumbo_Session_User

User Session Class

Author(s): Michael Luster <mluster79@yahoo.com>
License:New BSD License
Copyright:Copyright (c) 2007, iBayou, Michael Luster
Link:http://sourceforge.net/projects/phpgumbo
Version:0.0.1

Implements interfaces:

Inherited Methods

Class Variables

int|string $_user_id [line 42]
string $_user_key =  "user" [line 40]
boolean $_user_loaded [line 44]

Class Methods

public Gumbo_Session_User __construct ( [string $user_key] ) [line 52]

Constructor

Parameter(s):

  • (string) $user_key :: SESSION [key] name for User data
Overrides
Gumbo_Session_Encrypt::__construct()

[ Top ]
public string|int getUser ( ) [line 230]

Returns the User ID

Implementation of:
Gumbo_Interface_Session_User::getUser()

[ Top ]
public string getUserKey ( ) [line 222]

Returns the User Key

Implementation of:
Gumbo_Interface_Session_User::getUserKey()

[ Top ]
public bool isUserLoaded ( ) [line 238]

Returns if the User has been loaded

Implementation of:
Gumbo_Interface_Session_User::isUserLoaded()

[ Top ]
public void loadUser ( ) [line 66]

Loads the User SESSION data

The User Session Encrypted String is saved in the following format: session_id||user_id||agent||ip_address||date

  • postcondition:  _setUserLoaded ([true|false])
  • throws:  Gumbo_Exception
  • postcondition:  setUser ()
  • uses:  Gumbo_Date
Implementation of:
Gumbo_Interface_Session_User::loadUser()

[ Top ]
public void setUser ( int|string $userID ) [line 181]

Sets the User ID

Parameter(s):

  • (int|string) $userID
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session_User::setUser()

[ Top ]
public void setUserKey ( string $key ) [line 162]

Sets the User Key

Parameter(s):

  • (string) $key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Session_User::setUserKey()

[ Top ]
private void _saveUser ( ) [line 139]

Saves the User Session

The User Session Encrypted String is saved in the following format: session_id||user_id||agent||ip_address||date

  • precondition:  getUser()
  • throws:  Gumbo_Exception
  • uses:  Gumbo_Date

[ Top ]
private void _setUserLoaded ( bool $val ) [line 201]

Sets if the User was properly loaded

Parameter(s):

  • (bool) $val
  • throws:  Gumbo_Exception

[ Top ]