\USER

USER

Common methods for handling users.

Summary

Methods
Properties
Constants
__construct()
writeUser()
checkPassword()
writeLdapUser()
environment()
displayUserAddEdit()
displayUserAddEditPlain()
writeSessionPreferences()
loadSession()
displayUserDetails()
writePreferences()
listUserGroups()
grabAll()
deleteSql()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct() : 

USER

Returns

writeUser()

writeUser(  add = TRUE,   admin) : 

Write user details to WKX_users

If $admin = 0, this is a standard user. If $admin = 1, this is the initial configuration/reconfiguration and we need to insert superadmin details into the database. If $admin = 2, this is an admin editing or adding a user. a) the user may not change the username from this screen. When adding a user, we need to check there is not already $username (caseless) in the database. NB - returns FALSE in case of success, an error message in case of failure.

Parameters

add

Default is TRUE

admin

Default is 0

Returns

checkPassword()

checkPassword(  username,   pwdInput) : 

Compare encrypted passwords.

Decide if this is standard WIKINDX logon or LDAP logon

Parameters

username
pwdInput

Returns

writeLdapUser()

writeLdapUser(mixed||string|int  info,   username) : 

Write ldap user details to WKX_users

We don't store the LDAP password just 'LDAP' to indicate a LDAP user

Parameters

mixed||string|int info

ldap info

username

username

Returns

environment()

environment(mixed||string|int  row,   username = FALSE) : 

set up user environment on first logon

Parameters

mixed||string|int row
username

Default is FALSE

Returns

displayUserAddEdit()

displayUserAddEdit(mixed||string|int  row,   both = FALSE,   type = resource) : mixed||string|int

create 'added by..., edited by... details for displaying resources

Parameters

mixed||string|int row
both

Default is FALSE

type

Default is 'resource'

Returns

mixed||string|int —

($userAdd, $userEdit)

displayUserAddEditPlain()

displayUserAddEditPlain(  addId) : 

create username

Plain version of displayUserAddEdit() used in core/modules/email/EMAIL.php for notify emails

Parameters

addId

Returns

writeSessionPreferences()

writeSessionPreferences(  userId,   table = users,   upgrade = FALSE) : 

Store user preferences in the session setup_ array

Can come from users or config (default values for readOnly user in which case $userId = FALSE)

Parameters

userId
table
upgrade

Default is FALSE

Returns

loadSession()

loadSession(  id = FALSE) : 

Load user details into session mywikindx_ array

Parameters

id

Default is FALSE

Returns

displayUserDetails()

displayUserDetails(  form,   hidden,   admin = FALSE) : 

display user details from users table

If $admin != FALSE, it is the user id that an admin is editing

Parameters

form
hidden
admin

Default is FALSE

Returns

writePreferences()

writePreferences(\id  userId) : 

insert/update user preferences

Parameters

\id userId

Returns

listUserGroups()

listUserGroups() : 

List user's user groups

Returns

FALSE|array

grabAll()

grabAll(  full = FALSE,   useBib = FALSE,   addEdit = add) : 

Get users from users.

Return associative array of id => group of FALSE if no users.

Parameters

full

Default is FALSE

useBib

Default is FALSE

addEdit

Default is 'add'

Returns

FALSE|array

deleteSql()

deleteSql(mixed||string|int  input) : 

Delete user(s) from user table and handle users' metadata

Parameters

mixed||string|int input

Array of ids in WKX_users.

Returns