iBaseLogin Interface Reference

Inheritance diagram for iBaseLogin:

Public Member Functions
	loginForm ($return=false)
	controlLogin ()
	processLogin ($username, $password)
	lookupUser ($username, $password= '')
	setLogin ($select_user_array, $persistent=false)
	clearLogin ($set_guest=true)
	setGuest ()
	isLoggedIn ()

---

Detailed Description

Interface a plugin must implement to be used in authentification

---

Member Function Documentation

clearLogin

(

$

set_guest = true

)

Destroys login session data.

Implemented in PHPDS_login.

controlLogin

(

)

Check what to do with login action.

Implemented in PHPDS_login.

isLoggedIn

(

)

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

Returns:

boolean

Implemented in PHPDS_login.

loginForm

(

$

return = false

)

Loads the username & password html template form.

Parameters:

boolean

$return

Implemented in PHPDS_login, and StandardLogin.

lookupUser	(	$	username,
		$	password = ''
	)

Search the database for the given credentials

Parameters:

string	$username
string	$password

Returns:

array or false the user record

Implemented in PHPDS_login, and StandardLogin.

processLogin	(	$	username,
		$	password
	)

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

Parameters:

string	$username
string	$password

Implemented in PHPDS_login, and StandardLogin.

setGuest

(

)

Sets all settings to guest account.

Implemented in PHPDS_login.

setLogin	(	$	select_user_array,
		$	persistent = false
	)

Make the given user the logged in user

Parameters:

array

$select_user_array

Returns:

nothing

Implemented in PHPDS_login.

---

The documentation for this interface was generated from the following file:

• /home/jason/NetBeansProjects/phpdev/includes/PHPDS_login.class.php