AuthSession
in package
Table of Contents
Constants
- ERROR_INVALID_SESSION_KEY = 'INVALID_SESSION_KEY'
Methods
- checkKey() : bool
- Check Key
- createSession() : Session
- Create session key
- doLogin() : bool|string
- Login with username and password
- doLogout() : void
- Logout
- jumpStartSession() : bool
- Fills the session with necessary user info on the fly
Constants
ERROR_INVALID_SESSION_KEY
public
mixed
ERROR_INVALID_SESSION_KEY
= 'INVALID_SESSION_KEY'
Methods
checkKey()
Check Key
public
checkKey(string $sSessionKey) : bool
Check if the session key is valid. If yes returns true, otherwise false and sends an error message with error code 1
Parameters
- $sSessionKey : string
-
Auth credentials
Return values
boolcreateSession()
Create session key
public
createSession(string $username) : Session
Parameters
- $username : string
-
The username
Return values
SessiondoLogin()
Login with username and password
public
doLogin(string $sUsername, string $sPassword[, string $sPlugin = 'Authdb' ]) : bool|string
Parameters
- $sUsername : string
-
username
- $sPassword : string
-
password
- $sPlugin : string = 'Authdb'
-
plugin to be used
Return values
bool|stringdoLogout()
Logout
public
doLogout(string|null $sessionKey) : void
Parameters
- $sessionKey : string|null
jumpStartSession()
Fills the session with necessary user info on the fly
public
jumpStartSession(string $username) : bool
Parameters
- $username : string
-
The username