Docs For Class User

Class User

Description

abstract: Managers user accounts

Located in /user/User.php (line 15)

Method Summary

User __construct ()

void add (integer $id)

void authenticate ()

void delete ([integer $id = false])

void edit (integer $id)

void forgot ()

array groupList ()

boolean inGroup (string $group_name, [integer $user_id = false])

boolean isLoggedIn ()

void login (string $module_path)

void login_failed ()

void logout ()

string makePassword ([integer $length = 5])

void my_account ()

integer userAccountCount ()

boolean userHasAccess ([string $module = false], [string $method = false], [string $interface = false])

boolean userHasGlobalAccess ()

boolean usersGroups ([integer $user_id = false])

Methods

Constructor __construct (line 29)

abstract: Constructor, initializes the module
access: public

User __construct ()

add (line 37)

abstract: Displays and processes the add new user form
access: public

void add (integer $id)

integer $id

authenticate (line 329)

abstract: Handles authenticating the user
access: public

void authenticate ()

delete (line 225)

abstract: Deletes a user record
access: public

void delete ([integer $id = false])

integer $id

edit (line 95)

abstract: Displays and processes the edit user form
access: public

void edit (integer $id)

integer $id

forgot (line 274)

abstract: Displays and processes the forgotten password system
access: public

void forgot ()

groupList (line 618)

abstract: Returns a list of groups
access: public

array groupList ()

inGroup (line 487)

abstract: Returns whether a user is in a group
access: public

boolean inGroup (string $group_name, [integer $user_id = false])

string $group_name
integer $user_id

isLoggedIn (line 378)

abstract: Returns whether or not the user is logged in
access: public

boolean isLoggedIn ()

abstract: Displays the login page
access: public

void login (string $module_path)

string $module_path

login_failed (line 264)

abstract: Displays the login failed message and returns to login
access: public

void login_failed ()

logout (line 475)

abstract: Logs a user out
access: public

void logout ()

makePassword (line 589)

abstract: Generates new random password
access: public

string makePassword ([integer $length = 5])

integer $length

my_account (line 183)

abstract: Allows a user to change their own password
access: public

void my_account ()

userAccountCount (line 567)

abstract: Counts the number of user accounts
access: public

integer userAccountCount ()

userHasAccess (line 407)

abstract: Checks if user has permissions to access a page
access: public

boolean userHasAccess ([string $module = false], [string $method = false], [string $interface = false])

string $module
string $method
string $interface

userHasGlobalAccess (line 542)

abstract: Returns whether or not user has global access (admin/superuser)
access: public

boolean userHasGlobalAccess ()

usersGroups (line 514)

abstract: Returns an array of groups the user is in
access: public

boolean usersGroups ([integer $user_id = false])

integer $user_id

Documentation generated on Wed, 15 Apr 2009 17:03:41 -0700 by phpDocumentor 1.4.1