AUTHORIZE
    
            
            in package
            
        
    
    
    
AUTHORIZE
Logging on and system authorisation class.
Table of Contents
Properties
Methods
- authGate() : mixed
 - GDPR and/or privacy notification if required
 - checkNews() : mixed
 - Check for any news items in the database
 - clearEmbargoes() : mixed
 - Clear any expired embargoes
 - failure() : mixed
 - failure
 - logout() : mixed
 - log out user
 - printLogonTable() : string
 - print username/password text boxes
 - readOnly() : mixed
 - log out user in Read Only Mode
 
Properties
$db
object
    private
        mixed
    $db
    
    
    
    
    
$session
object
    private
        mixed
    $session
    
    
    
    
    
$vars
array
    private
        mixed
    $vars
    
    
    
    
    
Methods
authGate()
GDPR and/or privacy notification if required
    private
                    authGate() : mixed
    checkNews()
Check for any news items in the database
    private
                    checkNews() : mixed
    clearEmbargoes()
Clear any expired embargoes
    private
                    clearEmbargoes() : mixed
    failure()
failure
    private
                    failure([mixed $error = FALSE ]) : mixed
    In case of failure, Exit back to logon prompt with optional error message
Parameters
- $error : mixed = FALSE
 - 
                    
Default is FALSE
 
logout()
log out user
    private
                    logout([bool $readonly_mode = FALSE ]) : mixed
    Various bits of garbage disposal, session is destroyed and user is presented with logon prompt
If requested, the user keep a PHp session open in Read Only, not linked to its account.
Parameters
- $readonly_mode : bool = FALSE
 - 
                    
Default is FALSE.
 
printLogonTable()
print username/password text boxes
    private
                    printLogonTable() : string
    Return values
stringreadOnly()
log out user in Read Only Mode
    private
                    readOnly() : mixed
    This function is just a wrapper for logout().