USER
    
            
            in package
            
        
    
    
    
USER
Common methods for handling users.
Table of Contents
Properties
Methods
- checkBlocked() : bool
- Check if the user has been blocked by an admin
- checkDisallowedInSingleMode() : bool
- Check if the user is disallowed to auth in single mode
- checkPasswordBuiltin() : bool
- Compare encrypted passwords on WIKINDX
- formatLdapLogin() : string
- Format a login for ldap with the domain configured
- formatUser() : string
- Format a username for displaying 'added by' or 'edited by' details
- writeLdapUser() : mixed
- Write ldap user details to users
Properties
$db
object
    private
        mixed
    $db
    
    
    
    
    
$session
object
    private
        mixed
    $session
    
    
    
    
    
$vars
array
    private
        mixed
    $vars
    
    
    
    
    
Methods
checkBlocked()
Check if the user has been blocked by an admin
    private
                    checkBlocked(string $login) : bool
    Parameters
- $login : string
Return values
boolcheckDisallowedInSingleMode()
Check if the user is disallowed to auth in single mode
    private
                    checkDisallowedInSingleMode(string $login) : bool
    Only the superadmin can be logged in if the multiuser mode is not enable.
Parameters
- $login : string
Return values
boolcheckPasswordBuiltin()
Compare encrypted passwords on WIKINDX
    private
                    checkPasswordBuiltin(string $usersUsername, string $pwdInput[, bool $bSuperAdmin = FALSE ]) : bool
    Return FALSE for password not found or password doesn't match. Superadmin is always id = 1
Parameters
- $usersUsername : string
- $pwdInput : string
- $bSuperAdmin : bool = FALSE
- 
                    If TRUE, restrict verification to superadmin account 
Return values
boolformatLdapLogin()
Format a login for ldap with the domain configured
    private
                    formatLdapLogin(string $login) : string
    Use it only for the binding user.
Parameters
- $login : string
Return values
stringformatUser()
Format a username for displaying 'added by' or 'edited by' details
    private
                    formatUser(array<string|int, mixed> $row, string $type) : string
    Parameters
- $row : array<string|int, mixed>
- $type : string
- 
                    ('add'|'edit') 
Return values
stringwriteLdapUser()
Write ldap user details to users
    private
                    writeLdapUser(string $usersUsername, array<string|int, mixed> $ldapUserEntry) : mixed
    We don't store the LDAP password just 'LDAP' to indicate a LDAP user
Parameters
- $usersUsername : string
- 
                    Username 
- $ldapUserEntry : array<string|int, mixed>
- 
                    User ldap info get from checkPasswordLdap()