Procedural File: users.php

Source Location: /public_html/users.php

Page Details:

This file handles user authentication

Tags:

author:	Tony Bibbs <tony@tonybibbs.com>
author:	Mark Limburg <mlimburg@users.sourceforge.net>
author:	Jason Whittenburg

Includes:

require_once('lib-common.php') [line 47]
Geeklog common function library

require_once($_CONF['path_system'].'classes/openidhelper.class.php') [line 832]
require_once($_CONF['path_system'].'lib-user.php') [line 48]
require_once($_CONF['path_system'].'classes/oauthhelper.class.php') [line 907]

createuser [line 200]

string createuser(
string $username, string $email, string $email_conf)

Creates a user

Creates a user with the give username and email address

Tags:

return:

HTML for the form again if error occurs, otherwise nothing.

Parameters

string	$username	username to create user for
string	$email	email address to assign to user
string	$email_conf	confirmation email address check

[ Top ]

defaultform [line 431]

string defaultform(
string $msg)

Account does not exist - show both the login and register forms

Tags:

return:

HTML for form

Parameters

string

$msg

message to display if one is needed

[ Top ]

displayLoginErrorAndAbort [line 461]

void displayLoginErrorAndAbort(
int $msg, string $message_title, string $message_text)

Display message after a login error

Tags:

return:

function does not return!

Parameters

int	$msg	message number for custom handler
string	$message_title	title for the message box
string	$message_text	text of the message box

[ Top ]

emailpassword [line 67]

string emailpassword(
string $username, [int $msg = 0])

Emails password to a user

This will email the given user their password.

Tags:

return:

Optionally returns the HTML for the default form if the user info can't be found

Parameters

string	$username	Username for which to get and email password
int	$msg	Message number of message to show when done

[ Top ]

getpasswordform [line 403]

string getpasswordform(
)

Shows the password retrieval form

Tags:

return:

HTML for form used to retrieve user's password

[ Top ]

loginform [line 315]

string loginform(
[boolean $hide_forgotpw_link = false], [int $userstatus = -1])

Shows the user login form after failed attempts to either login or access a page requiring login.

Tags:

return:

HTML for login form

Parameters

boolean	$hide_forgotpw_link	whether to hide "forgot password?" link
int	$userstatus	status of the user's account

[ Top ]

newpasswordform [line 164]

string newpasswordform(
uid $uid, requestid $requestid)

Display a form where the user can enter a new password.

Tags:

return:

new password form

Parameters

uid	$uid	int user id
requestid	$requestid	string request id for password change

[ Top ]

newuserform [line 348]

string newuserform(
[int $msg = ''], string $referrer)

Shows the user registration form

Tags:

return:

HTML for user registration page

Parameters

int	$msg	message number to show
string	$referrer	page to send user to after registration

[ Top ]

requestpassword [line 109]

string requestpassword(
username $username)

User request for a new password - send email with a link and request id

Tags:

return:

form or meta redirect

Parameters

username

$username

string name of user who requested the new password

[ Top ]

resend_request [line 495]

void resend_request(
)

Re-send a request after successful re-authentication

Re-creates a GET or POST request based on data passed along in a form. Used in case of an expired security token so that the user doesn't lose changes.

[ Top ]

Documentation generated on Thu, 24 May 2012 02:09:28 -0400 by phpDocumentor 1.4.3