login.lib.php File Reference

Controls logging in/logging out. More...

Functions
	browserLogin ()
	customize browser title when logging in
	loginLink ()
	creates a login link
	registerLink ()
	creates a register link
	preferencesLink ()
	creates a preferences link
	logoffLink ()
	creates a logoff link
	userMenu ()
	creates a user link as an unordered list the menu may contain (depending on global configuration, user login ...) login link logged in information preferences link register link logoff link
	loginBox ()
	display a login form
	onLogin ()
	called when the user submit the login form
	onLogoff ()
	called when the user click the logoff link
Variables
	$contentBoxHandle ['login'] = 'loginBox'
	$userActionHandle ['login'] = 'onLogin'
	$userActionHandle ['logoff'] = 'onLogoff'
	$browserTitlePageHandle ['login'] = 'browserLogin'

---

Detailed Description

Controls logging in/logging out.

This file creates several hooks :

• login : to log'in
• logoff : to log'out

This page contains also several helper functions for the user to create template :

• loginLink
• registerLink
• preferencesLink
• logoffLink
• userMenu

---

Function Documentation

browserLogin

(

)

customize browser title when logging in

Returns:

browser title

loginBox

(

)

display a login form

Returns:

html blob

onLogin

(

)

called when the user submit the login form

onLogoff

(

)

called when the user click the logoff link

---