Documentation

session extends dataset
in package
Uses eventModuleEmpty

Session Objekt

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2020, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

$currentUser  : author
Aktueller Benutzer
$cache  : cache
System-Cache
$cacheName  : string
Cache name
$config  : config
System-Config-Objekt
$data  : array<string|int, mixed>
data-Array für nicht weiter definierte Eigenschaften
$dbcon  : database
DB-Verbindung
$dbExcludes  : array<string|int, mixed>
Klassen-Eigenschaften, die nicht gespeichert werden sollen
$editAction  : string
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$external  : bool
Kam Session durch externen Login via API zustande?
$id  : int
Objekt-ID
$ip  : string
IP-Adresse der Session
$language  : language
System-Sprachen-Objekt
$lastaction  : int
Letzte Aktualisierung
$login  : int
Login-Zeit
$logout  : int
Logout-Zeit
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$session  : session
System-Session
$sessionExists  : bool
Existiert Session
$sessionid  : string
Session-ID
$table  : string
Tabellen-Name
$useragent  : string
Session user agent string
$userid  : int
Benutzer-ID
__construct()  : void
Initialisiert Session
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
authenticate()  : bool
Check if authentication information in $data matchs data of active \fpcm\model\abstracts\authProvider object
clearSessions()  : bool
Sessions löschen
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : void
not used
deleteCookie()  : bool
Löscht Cookie
exists()  : bool
Prüft, ob Session existiert
generateSessionId()  : string
Generates session id string
getCurrentUser()  : author
Gibt aktuellen Benutzer dieser Session zurück
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getExternal()  : int
Flag auslesen, ob externe Session
getId()  : int
Gibt Object-ID zurück
getIp()  : string
IP-Adresse des aktuellen Benutzers
getLastaction()  : int
Zeit der letzten Aktion +/- 60sec
getLogin()  : int
Login-Zeit zurückgeben
getLogout()  : int
Logout-Zeit zurückgeben
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getSessionId()  : string
Session-ID-String zurückgeben
getSessions()  : array<string|int, mixed>
Gibt gespeicherte Session-Informationen zurück
getUseragent()  : string
User agent string
getUserId()  : int
ID des aktuellen Benutzers
init()  : bool
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
pingExternal()  : bool
Prüft ob übergebene Session-ID existiert und noch gültig ist
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
save()  : void
Speichert
setCookie()  : bool
Setzt Login-Cookie
setExternal()  : mixed
Flag externer Login via API setzen
setId()  : mixed
Set dataset id
setIp()  : mixed
IP-Adresse setzen
setLastaction()  : mixed
Zeitpunkt letzter Aktion setzen
setLogin()  : mixed
Login-Zeit setzen
setLogout()  : mixed
Logout-Zeit setzen
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setSessionExists()  : mixed
Session-Status setzen
setSessionId()  : mixed
Session-ID-String setzen
setUseragent()  : mixed
Set user agent data
setUserId()  : mixed
Benutzer-ID setzen
update()  : void
Aktualisiert
afterSaveInternal()  : bool
Is triggered after successful database insert
afterUpdateInternal()  : bool
Is triggered after successful database update
getEventModule()  : string
Returns event base string
getEventName()  : string
Returns full event name string
getPreparedSaveParams()  : array<string|int, mixed>
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften

Properties

$cacheName

Cache name

protected string $cacheName = false

$data

data-Array für nicht weiter definierte Eigenschaften

protected array<string|int, mixed> $data = []

$dbExcludes

Klassen-Eigenschaften, die nicht gespeichert werden sollen

protected array<string|int, mixed> $dbExcludes = array('sessionExists', 'currentUser', 'permissions')

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$external

Kam Session durch externen Login via API zustande?

protected bool $external
Tags
since
3.5

$ip

IP-Adresse der Session

protected string $ip

$lastaction

Letzte Aktualisierung

protected int $lastaction

$login

Login-Zeit

protected int $login

$logout

Logout-Zeit

protected int $logout

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$sessionExists

Existiert Session

protected bool $sessionExists = false

$sessionid

Session-ID

protected string $sessionid

$table

Tabellen-Name

protected string $table

$useragent

Session user agent string

protected string $useragent = ''
Tags
since
4

$userid

Benutzer-ID

protected int $userid

Methods

__construct()

Initialisiert Session

public __construct([int $init = true ]) : void
Parameters
$init : int = true
Return values
void —

__destruct()

Konstruktor

public __destruct() : void
Return values
void —

__get()

Magic get

public __get(string $name) : mixed
Parameters
$name : string
Return values
mixed —

__set()

Magic set

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed —

__toString()

Magic string

public __toString() : string
Return values
string —

authenticate()

Check if authentication information in $data matchs data of active \fpcm\model\abstracts\authProvider object

public authenticate(array<string|int, mixed> $data[, bool $external = false ]) : bool
Parameters
$data : array<string|int, mixed>
$external : bool = false
Return values
bool —

clearSessions()

Sessions löschen

public clearSessions() : bool
Return values
bool —

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

public createFromDbObject(object $object) : bool
Parameters
$object : object
Return values
bool —

delete()

not used

public delete() : void
Return values
void —

deleteCookie()

Löscht Cookie

public deleteCookie() : bool
Return values
bool —

exists()

Prüft, ob Session existiert

public exists() : bool
Return values
bool —

generateSessionId()

Generates session id string

public generateSessionId() : string
Tags
since
4.3
Return values
string —

getCurrentUser()

Gibt aktuellen Benutzer dieser Session zurück

public getCurrentUser() : author
Return values
author —

getData()

Gibt Inhalt von "data" zurück

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getEditLink()

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string —

getExternal()

Flag auslesen, ob externe Session

public getExternal() : int
Tags
since
3.5
Return values
int —

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int —

getIp()

IP-Adresse des aktuellen Benutzers

public getIp() : string
Return values
string —

getLastaction()

Zeit der letzten Aktion +/- 60sec

public getLastaction() : int
Return values
int —

getLogin()

Login-Zeit zurückgeben

public getLogin() : int
Return values
int —

getLogout()

Logout-Zeit zurückgeben

public getLogout() : int
Return values
int —

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata() : bool
Return values
bool —

getPreparedValueParams()

Gibt array mit Values für Prepared Statements zurück

public getPreparedValueParams([int $count = false ]) : int
Parameters
$count : int = false
Return values
int —

getSessionId()

Session-ID-String zurückgeben

public getSessionId() : string
Return values
string —

getSessions()

Gibt gespeicherte Session-Informationen zurück

public getSessions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUseragent()

User agent string

public getUseragent() : string
Return values
string —

getUserId()

ID des aktuellen Benutzers

public getUserId() : int
Return values
int —

init()

Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde

public init() : bool
Return values
bool —

pingExternal()

Prüft ob übergebene Session-ID existiert und noch gültig ist

public pingExternal(string $sessionId) : bool
Parameters
$sessionId : string
Tags
since
3.4
Return values
bool —

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave() : bool
Tags
since
3.6
Return values
bool —

save()

Speichert

public save() : void
Return values
void —

setCookie()

Setzt Login-Cookie

public setCookie() : bool
Return values
bool —

setExternal()

Flag externer Login via API setzen

public setExternal(bool $external) : mixed
Parameters
$external : bool
Return values
mixed —

setId()

Set dataset id

public setId(int $id) : mixed
Parameters
$id : int
Return values
mixed —

setIp()

IP-Adresse setzen

public setIp(string $ip) : mixed
Parameters
$ip : string
Return values
mixed —

setLastaction()

Zeitpunkt letzter Aktion setzen

public setLastaction(int $lastaction) : mixed
Parameters
$lastaction : int
Return values
mixed —

setLogin()

Login-Zeit setzen

public setLogin(int $login) : mixed
Parameters
$login : int
Return values
mixed —

setLogout()

Logout-Zeit setzen

public setLogout(int $logout) : mixed
Parameters
$logout : int
Return values
mixed —

setNodata()

Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden

public setNodata(bool $nodata) : mixed
Parameters
$nodata : bool
Return values
mixed —

setSessionExists()

Session-Status setzen

public setSessionExists(bool $sessionExists) : mixed
Parameters
$sessionExists : bool
Return values
mixed —

setSessionId()

Session-ID-String setzen

public setSessionId(string $sessionid) : mixed
Parameters
$sessionid : string
Return values
mixed —

setUseragent()

Set user agent data

public setUseragent(string $useragent) : mixed
Parameters
$useragent : string
Return values
mixed —

setUserId()

Benutzer-ID setzen

public setUserId(int $userid) : mixed
Parameters
$userid : int
Return values
mixed —

update()

Aktualisiert

public update() : void
Return values
void —

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal() : bool
Tags
since
4.1
Return values
bool —

afterUpdateInternal()

Is triggered after successful database update

protected afterUpdateInternal() : bool
Tags
since
4.1
Return values
bool —

getEventModule()

Returns event base string

protected abstract getEventModule() : string
Tags
since
4.1
Return values
string —

getEventName()

Returns full event name string

protected final getEventName(string $event) : string
Parameters
$event : string
Tags
since
4.1
Return values
string —

getPreparedSaveParams()

Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften

protected getPreparedSaveParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results