AUTHORIZE
    
            
            in package
            
        
    
    
    
        
            AUTHORIZE
Logging on and system authorisation class.
Table of Contents
- $db : mixed
 - object
 - $errors : mixed
 - object
 - $session : mixed
 - object
 - $success : mixed
 - object
 - $vars : mixed
 - array
 - 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
 
Properties
$db
object
    private
        mixed
    $db
    
    
        
    
$errors
object
    private
        mixed
    $errors
    
    
        
    
$session
object
    private
        mixed
    $session
    
    
        
    
$success
object
    private
        mixed
    $success
    
    
        
    
$vars
array
    private
        mixed
    $vars
    
    
        
    
Methods
authGate()
GDPR and/or privacy notification if required
    private
                authGate() : mixed
    
    
    
        Return values
mixed —checkNews()
Check for any news items in the database
    private
                checkNews() : mixed
    
    
    
        Return values
mixed —clearEmbargoes()
Clear any expired embargoes
    private
                clearEmbargoes() : mixed
    
    
    
        Return values
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
 
Return values
mixed —logout()
log out user
    private
                logout() : mixed
        Various bits of garbage disposal, session is destroyed, cookie is deleted and user is presented with logon prompt
Return values
mixed —printLogonTable()
print username/password text boxes
    private
                printLogonTable() : string
    
    
    
        Return values
string —readOnly()
log out user
    private
                readOnly() : mixed
        Various bits of garbage disposal, session is destroyed, cookie is deleted and user is presented with logon prompt