User

function exportVars( & $tpl )

Convenience function to export relevant user data to a template.  Sets the username, full name, e-mail, homepage, and display name in template variables USER_ID, USER_NAME, USER_EMAIL, USER_HOMEPAGE, and USER_DISPLAY_NAME respectively.

Parameters

function checkPassword( $pass )

Checks if a password is valid for the current user.

Parameters

Returns

True if the password is correct, false owtherwise.

function save()

Save changes to user data.

Returns

True if the changes were successfully saved, false otherwise.

function password( $pwd  =  false )

Set or return the user’s password>

Parameters

Returns

If pwd is false, return the user’s password hash.  Otherwise, a new password is set and there is no return value.

function username( $uid  =  false )

Set or return the username.

Parameters

Returns

The username if uid is false, otherwise the username is set and there is no return value.

function name( $nm  =  false )

Set or return the user’s long name.

Parameters

Returns

The user’s full name if nm is false, otherwise the name is set and there is no return value.

function displayName()

Returns a name to display.  If a full name is defined, it uses that.  Otherwise, it reverts to the username.

Returns

A string contianing either the username or full name.

function email( $mail  =  false )

Set or return the user’s e-mail address.

Parameters

Returns

The user’s e-mail address if mail is false, otherwise the address is set and there is no return value.

function homepage( $url  =  false )

Set or return the user’s homepage.

Parameters

Returns

The user’s homepage URL if url is false, otherwise the homepage is set and there is no return value.

function groups()

Lists the groups to which the user belongs.

Returns

An array of group names to which the user belongs.

function defaultGroup( $val  =  false )

Gets or sets the default group for this user.  This is the group to which all of the user’s creations will belong by default.

Parameters

Returns

A string with the name of the group.

function addToGroup( $groupname )

Adds the user to the specified group.

Parameters

Returns

True on success, false on failure.

function login( $pwd )

Logs the user in.  Note that there are two login methods available, with the one used being determined by the AUTH_USE_SESSION configuration constant.

Parameters

Returns

False if the authentication fails, true otherwise.

function logout()

Logs the user out and destroys login tokens.  Note that this is also subject to AUTH_USE_SESSION

function checkLogin( $uname  =  false )

Checks tokens to determine if the user is logged in.

Parameters

Returns

True if the user has valid login tokens, false otherwise.

function isAdministrator()

Determines if the user is the system administrator.

Returns

True if the username is the same as that of the system administrator, false otherwise.  Note that the system administrator’s username is controlled by the ADMIN_USER configuration constant.