Docs For Class BumblebeeAuth

Description

User *authorisation* and *authentication* object

todo: //TODO: update permissions system
todo: //TODO: documentation

BasicAuth
   |
   --BumblebeeAuth

Variable Summary

mixed $anonymous

mixed $ename

mixed $euid

mixed $eusername

mixed $permissions

mixed $system_permissions

Method Summary

BumblebeeAuth BumblebeeAuth (array $data, [boolean $recheck = false], [string $table = 'users'])

void amMasqed ()

void assumeMasq ( $id)

void getEUID ()

void instrument_permissions ( $instrument)

void isInstrumentAdmin ( $instr)

void isSystemAdmin ()

void masqPermitted ([ $instr = 0])

void permitted ( $operation, [ $instrument = NULL])

void removeMasq ()

void _changeUser ()

void _checkAnonymous ( &$data)

void _checkMasq ()

integer _constructInstrumentPermission (array $row)

void _loadPermissions ()

Variables

mixed $anonymous = false (line 39)

mixed $ename (line 41)

mixed $euid (line 40)

mixed $eusername (line 42)

mixed $permissions = array() (line 43)

mixed $system_permissions = 0 (line 44)

Inherited Variables

Inherited from BasicAuth

BasicAuth::$DEBUG
BasicAuth::$email
BasicAuth::$localLogin
BasicAuth::$name
BasicAuth::$table
BasicAuth::$uid
BasicAuth::$username
BasicAuth::$user_row
BasicAuth::$_error
BasicAuth::$_loggedin

Methods

Constructor BumblebeeAuth (line 53)

Create the auth object

BumblebeeAuth BumblebeeAuth (array $data, [boolean $recheck = false], [string $table = 'users'])

array $data: array containing keys 'username' and 'pass'
boolean $recheck: (optional) ignore session data and check anyway
string $table: (optional) db table from which login data should be taken

amMasqed (line 177)

void amMasqed ()

assumeMasq (line 184)

start masquerading as another user

void assumeMasq ( $id)

$id

getEUID (line 169)

void getEUID ()

instrument_permissions (line 109)

void instrument_permissions ( $instrument)

$instrument

isInstrumentAdmin (line 100)

void isInstrumentAdmin ( $instr)

$instr

isSystemAdmin (line 92)

void isSystemAdmin ()

masqPermitted (line 173)

void masqPermitted ( $instr)

$instr

permitted (line 208)

void permitted ( $operation, [ $instrument = NULL])

$operation
$instrument

removeMasq (line 202)

stop masquerading as another user

void removeMasq ()

_changeUser (line 65)

void _changeUser ()

_checkAnonymous (line 71)

void _checkAnonymous ( &$data)

&$data

_checkMasq (line 84)

Permit user masquerading -- the admin user can become another user for a period

of time to make a bookings etc

void _checkMasq ()

_constructInstrumentPermission (line 158)

make up the permissions for the instrument

return: permissions

integer _constructInstrumentPermission (array $row)

array $row: from the database

_loadPermissions (line 234)

void _loadPermissions ()

Inherited Methods

Inherited From BasicAuth

BasicAuth::BasicAuth()
BasicAuth::getRemoteIP()
BasicAuth::isLoggedIn()
BasicAuth::isMe()
BasicAuth::isValidTag()
BasicAuth::loginError()
BasicAuth::logout()
BasicAuth::makeValidationTag()
BasicAuth::updatePassword()
BasicAuth::_auth_local()
BasicAuth::_auth_via_ldap()
BasicAuth::_auth_via_radius()
BasicAuth::_createSession()
BasicAuth::_login()
BasicAuth::_retrieveUserInfo()
BasicAuth::_var_get()
BasicAuth::_var_put()
BasicAuth::_verifyLogin()