\AUTHORIZE

AUTHORIZE

Logging on and system authorisation class.

Summary

Methods
Properties
Constants
__construct()
gatekeep()
initLogon()
logonCheckUpgradeDB()
logonCheck()
isPluginExecutionAuthorised()
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() : 

AUTHORIZE

Returns

gatekeep()

gatekeep() : 

gatekeeper to the system.

Order is of checking is important!

Returns

initLogon()

initLogon(  error = FALSE) : 

Display the empty form for logging on

Parameters

error

Default is FALSE

Returns

logonCheckUpgradeDB()

logonCheckUpgradeDB(  username,   password, \constant  dbVersion = WIKINDX_VERSION) : 

Initial logon to the system when upgrading the database.

Parameters

username
password
\constant dbVersion

default = WIKINDX_VERSION

Returns

TRUE if not able to authenticate

logonCheck()

logonCheck(  username,   password) : 

Initial logon to the system.

Public for use with API. If cleared, user environment is set and embargoed resources checked for clearance, otherwise, user is presented with logon prompt again

Parameters

username
password

Returns

isPluginExecutionAuthorised()

isPluginExecutionAuthorised(  pluginAuthLevelRequested,   promptForLogin = FALSE) : 

isPluginExecutionAuthorised

Check if the level of auth matchs the level requested by the calling plugin. If $promptForLogin is TRUE, displays the login page instead of returning FALSE, when the plugin is not authorised

Parameters

pluginAuthLevelRequested

Default is 0. Auth level: unknow => always unauthorised, menu item not displayed 0 => menu item displayed for all users (logged or not) 1 => menu item displayed for users logged (with write access) 2 => menu item displayed only for logged admins

promptForLogin

Default is FALSE.

Returns