Interface iBaseLogin

Description

Interface a plugin must implement to be used in authentification

Located in /PHPDS_login.class.php (line 19)


	
			
Method Summary
void clearLogin ([ $set_guest = true])
void controlLogin ()
boolean isLoggedIn ()
void loginForm ([boolean $return = false])
array lookupUser (string $username, [string $password = ''])
void processLogin (string $username, string $password)
void setGuest ()
nothing setLogin (array $select_user_array, [ $persistent = false])
Methods
clearLogin (line 64)

Destroys login session data.

  • access: public
void clearLogin ([ $set_guest = true])
  • $set_guest
controlLogin (line 33)

Check what to do with login action.

  • access: public
void controlLogin ()
isLoggedIn (line 77)

Check is user is logged in, return false if not.

  • access: public
boolean isLoggedIn ()
loginForm (line 27)

Loads the username & password html template form.

  • access: public
void loginForm ([boolean $return = false])
  • boolean $return
lookupUser (line 50)

Search the database for the given credentials

  • return: or false the user record
  • access: public
array lookupUser (string $username, [string $password = ''])
  • string $username
  • string $password
processLogin (line 41)

Checks to see if user and password is correct and allowed. Then creates session data accordingly.

  • access: public
void processLogin (string $username, string $password)
  • string $username
  • string $password
setGuest (line 70)

Sets all settings to guest account.

  • access: public
void setGuest ()
setLogin (line 58)

Make the given user the logged in user

  • access: public
nothing setLogin (array $select_user_array, [ $persistent = false])
  • array $select_user_array
  • $persistent

Documentation generated on Tue, 09 Aug 2011 09:05:12 +0200 by phpDocumentor 1.4.3