Constants

SYSTEM_ID

SYSTEM_ID = 'backend_login'

LOGIN_TRIES_1

LOGIN_TRIES_1 = 3

RELOGIN_DELAY_1

RELOGIN_DELAY_1 = 5

LOGIN_TRIES_2

LOGIN_TRIES_2 = 50

RELOGIN_DELAY_2

RELOGIN_DELAY_2 = 3600

Properties

$DB

$DB : int

Type

int

$sessionDuration

$sessionDuration

$loginQuery

$loginQuery

$userQuery

$userQuery

$impersonateQuery

$impersonateQuery

$systemId

$systemId : string

Type

string

$userLogin

$userLogin

$userPassword

$userPassword

$logout

$logout : bool

Type

bool

$idColumn

$idColumn : string

Type

string

$passwordColumn

$passwordColumn : string

Type

string

$cache

$cache : bool

Type

bool

$loginStatus

$loginStatus : int

Type

int

$message

$message : string

Type

string

$user

$user : \rex_sql|\rex_user

Type

rex_user

$impersonator

$impersonator : \rex_sql|\rex_user|null

Type

rex_user|null

Methods

__construct()

__construct() : mixed

Constructor.

Returns

mixed —

setCache()

setCache(mixed  $status = true) : mixed

Setzt, ob die Ergebnisse der Login-Abfrage pro Seitenaufruf gecached werden sollen.

Parameters

mixed $status

Returns

mixed —

setSqlDb()

setSqlDb(mixed  $DB) : mixed

Setzt die Id der zu verwendenden SQL Connection.

Parameters

mixed $DB

Returns

mixed —

setSystemId()

setSystemId(mixed  $systemId) : mixed

Setzt eine eindeutige System Id, damit mehrere Sessions auf der gleichen Domain unterschieden werden können.

Parameters

mixed $systemId

Returns

mixed —

setSessionDuration()

setSessionDuration(mixed  $sessionDuration) : mixed

Setzt das Session Timeout.

Parameters

mixed $sessionDuration

Returns

mixed —

setLogin()

setLogin(mixed  $login, mixed  $password, mixed  $isPreHashed = false) : mixed

Setzt den Login und das Password.

Parameters

mixed $login
mixed $password
mixed $isPreHashed

Returns

mixed —

setLogout()

setLogout(mixed  $logout) : mixed

Markiert die aktuelle Session als ausgeloggt.

Parameters

mixed $logout

Returns

mixed —

isLoggedOut()

isLoggedOut() : mixed

Prüft, ob die aktuelle Session ausgeloggt ist.

Returns

mixed —

setUserQuery()

setUserQuery(string  $userQuery) : mixed

Setzt den UserQuery.

Dieser wird benutzt, um einen bereits eingeloggten User im Verlauf seines Aufenthaltes auf der Webseite zu verifizieren

Parameters

string $userQuery

Returns

mixed —

setImpersonateQuery()

setImpersonateQuery(mixed  $impersonateQuery) : mixed

Setzt den ImpersonateQuery.

Dieser wird benutzt, um den User abzurufen, dessen Identität ein Admin einnehmen möchte.

Parameters

mixed $impersonateQuery

Returns

mixed —

setLoginQuery()

setLoginQuery(string  $loginQuery) : mixed

Setzt den LoginQuery.

Dieser wird benutzt, um den eigentlichne Loginvorgang durchzuführen. Hier wird das eingegebene Password und der Login eingesetzt.

Parameters

string $loginQuery

Returns

mixed —

setIdColumn()

setIdColumn(mixed  $idColumn) : mixed

Setzt den Namen der Spalte, der die User-Id enthält.

Parameters

mixed $idColumn

Returns

mixed —

setPasswordColumn()

setPasswordColumn(string  $passwordColumn) : mixed

Sets the password column.

Parameters

string $passwordColumn

Returns

mixed —

getMessage()

getMessage() : string

Returns the message.

Returns

string —

checkLogin()

checkLogin() : bool

Prüft die mit setLogin() und setPassword() gesetzten Werte anhand des LoginQueries/UserQueries und gibt den Status zurück.

Gibt true zurück bei erfolg, sonst false

Returns

bool —

impersonate()

impersonate(mixed  $id) : mixed

Parameters

mixed $id

Returns

mixed —

depersonate()

depersonate() : mixed

Returns

mixed —

getUser()

getUser() : \rex_sql|\rex_user|null

Returns

\rex_sql|\rex_user|null —

getImpersonator()

getImpersonator() : \rex_sql|\rex_user|null

Returns

\rex_sql|\rex_user|null —

getValue()

getValue(mixed  $key, mixed  $default = null) : mixed

Gibt einen Benutzer-Spezifischen Wert zurück.

Parameters

mixed $key
mixed $default

Returns

mixed —

setSessionVar()

setSessionVar(mixed  $varname, mixed  $value) : mixed

Setzte eine Session-Variable.

Parameters

mixed $varname
mixed $value

Returns

mixed —

getSessionVar()

getSessionVar(mixed  $varname, mixed  $default = '') : mixed

Gibt den Wert einer Session-Variable zurück.

Parameters

mixed $varname
mixed $default

Returns

mixed —

startSession()

startSession() : mixed

starts a http-session if not already started.

Returns

mixed —

passwordHash()

passwordHash(mixed  $password, mixed  $isPreHashed = false) : string

Verschlüsselt den übergebnen String.

Parameters

mixed $password
mixed $isPreHashed

Throws

\rex_exception

Returns

string —

Returns the hashed password

passwordVerify()

passwordVerify(mixed  $password, mixed  $hash, mixed  $isPreHashed = false) : bool

Parameters

mixed $password
mixed $hash
mixed $isPreHashed

Returns

bool —

returns TRUE if the password and hash match, or FALSE otherwise

passwordNeedsRehash()

passwordNeedsRehash(mixed  $hash) : bool

Parameters

mixed $hash

Returns

bool —

returns TRUE if the hash should be rehashed to match the given algo and options, or FALSE otherwise

setStayLoggedIn()

setStayLoggedIn(mixed  $stayLoggedIn = false) : mixed

Parameters

mixed $stayLoggedIn

Returns

mixed —

requiresPasswordChange()

requiresPasswordChange() : bool

Returns

bool —

changedPassword()

changedPassword() : void

deleteSession()

deleteSession() : mixed

Returns

mixed —

hasSession()

hasSession() : bool

Returns

bool —

createUser()

createUser() : \rex_user|null

Creates the user object if it does not already exist.

Helpful if you want to check permissions of the backend user in frontend. If you only want to know if there is any backend session, use {@link}.

Returns

\rex_user|null —

getUser()

getUser() : \rex_sql|\rex_user|null

Returns

\rex_sql|\rex_user|null —

getImpersonator()

getImpersonator() : \rex_sql|\rex_user|null

Returns

\rex_sql|\rex_user|null —

setMessage()

setMessage(mixed  $message) : mixed

Setzt einen Meldungstext.

Parameters

mixed $message

Returns

mixed —

regenerateSessionId()

regenerateSessionId() : mixed

Returns

mixed —

getSessionNamespace()

getSessionNamespace() : string

returns the backends session namespace.

Returns

string —