API Documentation
\

\User

Class User

Summary

Methods
Properties
Constants
__construct()
load()
exists()
login()
logout()
hasPermission()
getUserData()
getUsername()
getRole()
isAdmin()
embedSupport()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_oUser
$_bUser
$_aUser
$_sError
N/A

Properties

$_oUser

$_oUser :

Type

$_bUser

$_bUser :

Type

$_aUser

$_aUser :

Type

$_sError

$_sError :

Type

Methods

__construct()

__construct() : $this

__construct()

Returns

$this

load()

load() : $this|boolean

load()

Singleton to secure to create only one instance of this class.

Returns

$this|boolean

exists()

exists(string  $sUsername) : boolean

exists()

Parameters

string $sUsername

Returns

boolean

login()

login() : boolean

login()

Returns

boolean

logout()

logout(  $bRedirect = TRUE) : void

logout()

Parameters

$bRedirect

hasPermission()

hasPermission(  $bNeedAdmin = FALSE,   $bRedirect = TRUE) : array|void

hasPermission()

Parameters

$bNeedAdmin
$bRedirect

Returns

array|void

getUserData()

getUserData(integer  $iKey) : mixed

getUserData()

Parameters

integer $iKey

Returns

mixed

getUsername()

getUsername() : string

getUsername()

Returns

string

getRole()

getRole() : string

getRole()

Returns

string

isAdmin()

isAdmin() : boolean

isAdmin()

Returns

boolean

embedSupport()

embedSupport() : boolean

embedSupport()

Returns

boolean