session
extends dataset
in
Uses
eventModuleEmpty
Session Objekt
Table of Contents
| $sessionid | Session-ID | string |
|---|---|---|
| $userid | Benutzer-ID | int |
| $login | Login-Zeit | int |
| $logout | Logout-Zeit | int |
| $lastaction | Letzte Aktualisierung | int |
| $ip | IP-Adresse der Session | string |
| $external | Kam Session durch externen Login via API zustande? | bool |
| $useragent | Session user agent string | string |
| $sessionExists | Existiert Session | bool |
| $dbExcludes | Klassen-Eigenschaften, die nicht gespeichert werden sollen | array |
| $currentUser | Aktueller Benutzer | author |
| $dbcon | DB-Verbindung | database |
| $id | Objekt-ID | int |
| $table | Tabellen-Name | string |
| $data | data-Array für nicht weiter definierte Eigenschaften | array |
| $dbExcludes | Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen | array |
| $nodata | $this->data beim Speichern nicht berücksichtigen | bool |
| $cache | System-Cache | cache |
| $session | System-Session | session |
| $events | Event-Liste | events |
| $config | System-Config-Objekt | config |
| $language | System-Sprachen-Objekt | language |
| $notifications | Notifications | notifications |
| $editAction | Controller-Pfad, wenn Objekt Edit-Action besitzt | string |
| $objExists | Objektexistiert | bool |
| $cacheName | Cache name | string |
| __construct() | Initialisiert Session | void |
| getSessionId() | Session-ID-String zurückgeben | string |
| getUserId() | ID des aktuellen Benutzers | int |
| getLogin() | Login-Zeit zurückgeben | int |
| getLogout() | Logout-Zeit zurückgeben | int |
| getLastaction() | Zeit der letzten Aktion +/- 60sec | int |
| getIp() | IP-Adresse des aktuellen Benutzers | string |
| getExternal() | Flag auslesen, ob externe Session | int |
| getUseragent() | User agent string | string |
| setSessionId() | Session-ID-String setzen | mixed |
| setUserId() | Benutzer-ID setzen | mixed |
| setLogin() | Login-Zeit setzen | mixed |
| setLogout() | Logout-Zeit setzen | mixed |
| setLastaction() | Zeitpunkt letzter Aktion setzen | mixed |
| setIp() | IP-Adresse setzen | mixed |
| setExternal() | Flag externer Login via API setzen | mixed |
| setUseragent() | Set user agent data | mixed |
| setSessionExists() | Session-Status setzen | mixed |
| getCurrentUser() | Gibt aktuellen Benutzer dieser Session zurück | author |
| exists() | Prüft, ob Session existiert | bool |
| save() | Speichert | void |
| update() | Aktualisiert | void |
| delete() | not used | void |
| authenticate() | Check if authentication information in $data matchs data of active \fpcm\model\abstracts\authProvider object | bool |
| setCookie() | Setzt Login-Cookie | bool |
| deleteCookie() | Löscht Cookie | bool |
| getSessions() | Gibt gespeicherte Session-Informationen zurück | array |
| clearSessions() | Sessions löschen | bool |
| init() | Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde | bool |
| __get() | Magic get | mixed |
| __set() | Magic set | mixed |
| pingExternal() | Prüft ob übergebene Session-ID existiert und noch gültig ist | bool |
| generateSessionId() | Generates session id string | string |
| getEventModule() | Returns event base string | string |
| __construct() | Konstruktor | void |
| __get() | Magic get | mixed |
| __set() | Magic set | mixed |
| __toString() | Magic string | string |
| __call() | Magische Methode für nicht vorhandene Methoden | bool |
| __callStatic() | Magische Methode für nicht vorhandene, statische Methoden | bool |
| __destruct() | Konstruktor | void |
| getData() | Gibt Inhalt von "data" zurück | array |
| init() | Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde | bool |
| getId() | Gibt Object-ID zurück | int |
| setId() | Set dataset id | mixed |
| exists() | Prüft ob Objekt existiert | bool |
| getNodata() | Prüft, ob "data" gespeichert werden soll | bool |
| setNodata() | Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden | mixed |
| save() | Executes save process to database and events | bool|int |
| update() | Executes update process to database and events | bool|int |
| delete() | Löscht ein Objekt in der Datenbank | bool |
| createFromDbObject() | Füllt Objekt mit Daten aus Datenbank-Result | bool |
| getPreparedSaveParams() | Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften | array |
| getPreparedValueParams() | Gibt array mit Values für Prepared Statements zurück | int |
| prepareDataSave() | Bereitet Daten für Speicherung in Datenbank vor | bool |
| getEditLink() | Gibt Link für Edit-Action zurück | string |
| getEventName() | Returns full event name string | string |
| afterSaveInternal() | Is triggered after successful database insert | bool |
| afterUpdateInternal() | Is triggered after successful database update | bool |
Properties
$sessionid
Session-ID
protected
string
$sessionid
$userid
Benutzer-ID
protected
int
$userid
$login
Login-Zeit
protected
int
$login
$logout
Logout-Zeit
protected
int
$logout
$lastaction
Letzte Aktualisierung
protected
int
$lastaction
$ip
IP-Adresse der Session
protected
string
$ip
$external
Kam Session durch externen Login via API zustande?
protected
bool
$external
$useragent
Session user agent string
protected
string
$useragent
= ''
$sessionExists
Existiert Session
protected
bool
$sessionExists
= false
$dbExcludes
Klassen-Eigenschaften, die nicht gespeichert werden sollen
protected
array
$dbExcludes
= array('sessionExists', 'currentUser', 'permissions')
$currentUser
Aktueller Benutzer
public
author
$currentUser
$dbcon
DB-Verbindung
protected
database
$dbcon
$id
Objekt-ID
protected
int
$id
$table
Tabellen-Name
protected
string
$table
$data
data-Array für nicht weiter definierte Eigenschaften
protected
array
$data
= []
$dbExcludes
Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen
protected
array
$dbExcludes
= []
$nodata
$this->data beim Speichern nicht berücksichtigen
protected
bool
$nodata
= true
$cache
System-Cache
protected
cache
$cache
$session
System-Session
protected
session
$session
$events
Event-Liste
protected
events
$events
$config
System-Config-Objekt
protected
config
$config
$language
System-Sprachen-Objekt
protected
language
$language
$notifications
Notifications
protected
notifications
$notifications
$editAction
Controller-Pfad, wenn Objekt Edit-Action besitzt
protected
string
$editAction
$objExists
Objektexistiert
protected
bool
$objExists
= false
$cacheName
Cache name
protected
string
$cacheName
= false
Methods
__construct()
Initialisiert Session
public
__construct(
[ $init :
int
= true ]
)
: void
Parameters
- $init : int = true
getSessionId()
Session-ID-String zurückgeben
public
getSessionId(
)
: string
Return values
stringgetUserId()
ID des aktuellen Benutzers
public
getUserId(
)
: int
Return values
intgetLogin()
Login-Zeit zurückgeben
public
getLogin(
)
: int
Return values
intgetLogout()
Logout-Zeit zurückgeben
public
getLogout(
)
: int
Return values
intgetLastaction()
Zeit der letzten Aktion +/- 60sec
public
getLastaction(
)
: int
Return values
intgetIp()
IP-Adresse des aktuellen Benutzers
public
getIp(
)
: string
Return values
stringgetExternal()
Flag auslesen, ob externe Session
public
getExternal(
)
: int
Tags
Return values
intgetUseragent()
User agent string
public
getUseragent(
)
: string
Return values
stringsetSessionId()
Session-ID-String setzen
public
setSessionId(
$sessionid :
string
)
: mixed
Parameters
- $sessionid : string
Return values
mixedsetUserId()
Benutzer-ID setzen
public
setUserId(
$userid :
int
)
: mixed
Parameters
- $userid : int
Return values
mixedsetLogin()
Login-Zeit setzen
public
setLogin(
$login :
int
)
: mixed
Parameters
- $login : int
Return values
mixedsetLogout()
Logout-Zeit setzen
public
setLogout(
$logout :
int
)
: mixed
Parameters
- $logout : int
Return values
mixedsetLastaction()
Zeitpunkt letzter Aktion setzen
public
setLastaction(
$lastaction :
int
)
: mixed
Parameters
- $lastaction : int
Return values
mixedsetIp()
IP-Adresse setzen
public
setIp(
$ip :
string
)
: mixed
Parameters
- $ip : string
Return values
mixedsetExternal()
Flag externer Login via API setzen
public
setExternal(
$external :
bool
)
: mixed
Parameters
- $external : bool
Return values
mixedsetUseragent()
Set user agent data
public
setUseragent(
$useragent :
string
)
: mixed
Parameters
- $useragent : string
Return values
mixedsetSessionExists()
Session-Status setzen
public
setSessionExists(
$sessionExists :
bool
)
: mixed
Parameters
- $sessionExists : bool
Return values
mixedgetCurrentUser()
Gibt aktuellen Benutzer dieser Session zurück
public
getCurrentUser(
)
: author
Return values
authorexists()
Prüft, ob Session existiert
public
exists(
)
: bool
Return values
boolsave()
Speichert
public
save(
)
: void
update()
Aktualisiert
public
update(
)
: void
delete()
not used
public
delete(
)
: void
authenticate()
Check if authentication information in $data matchs data of active \fpcm\model\abstracts\authProvider object
public
authenticate(
$data :
array
[, $external :
bool
= false ]
)
: bool
Parameters
- $data : array
- $external : bool = false
Return values
boolsetCookie()
Setzt Login-Cookie
public
setCookie(
)
: bool
Return values
booldeleteCookie()
Löscht Cookie
public
deleteCookie(
)
: bool
Return values
boolgetSessions()
Gibt gespeicherte Session-Informationen zurück
public
getSessions(
)
: array
Return values
arrayclearSessions()
Sessions löschen
public
clearSessions(
)
: bool
Return values
boolinit()
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
public
init(
)
: bool
Return values
bool__get()
Magic get
public
__get(
$name :
string
)
: mixed
Parameters
- $name : string
Return values
mixed__set()
Magic set
public
__set(
$name :
mixed
, $value :
mixed
)
: mixed
Parameters
- $name : mixed
- $value : mixed
Return values
mixedpingExternal()
Prüft ob übergebene Session-ID existiert und noch gültig ist
public
pingExternal(
$sessionId :
string
)
: bool
Parameters
- $sessionId : string
Tags
Return values
boolgenerateSessionId()
Generates session id string
public
generateSessionId(
)
: string
Tags
Return values
stringgetEventModule()
Returns event base string
protected
abstract getEventModule(
)
: string
Tags
Return values
string__construct()
Konstruktor
public
__construct(
[ $id :
int
= null ]
)
: void
Parameters
- $id : int = null
__get()
Magic get
public
__get(
$name :
string
)
: mixed
Parameters
- $name : string
Return values
mixed__set()
Magic set
public
__set(
$name :
mixed
, $value :
mixed
)
: mixed
Parameters
- $name : mixed
- $value : mixed
Return values
mixed__toString()
Magic string
public
__toString(
)
: string
Return values
string__call()
Magische Methode für nicht vorhandene Methoden
public
__call(
$name :
string
, $arguments :
mixed
)
: bool
Parameters
- $name : string
- $arguments : mixed
Return values
bool__callStatic()
Magische Methode für nicht vorhandene, statische Methoden
public
static __callStatic(
$name :
string
, $arguments :
mixed
)
: bool
Parameters
- $name : string
- $arguments : mixed
Return values
bool__destruct()
Konstruktor
public
__destruct(
)
: void
getData()
Gibt Inhalt von "data" zurück
public
getData(
)
: array
Return values
arrayinit()
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
public
init(
)
: bool
Return values
boolgetId()
Gibt Object-ID zurück
public
getId(
)
: int
Return values
intsetId()
Set dataset id
public
setId(
$id :
int
)
: mixed
Parameters
- $id : int
Return values
mixedexists()
Prüft ob Objekt existiert
public
exists(
)
: bool
Return values
boolgetNodata()
Prüft, ob "data" gespeichert werden soll
public
getNodata(
)
: bool
Return values
boolsetNodata()
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
public
setNodata(
$nodata :
bool
)
: mixed
Parameters
- $nodata : bool
Return values
mixedsave()
Executes save process to database and events
public
save(
)
: bool|int
Tags
Return values
bool|intupdate()
Executes update process to database and events
public
update(
)
: bool|int
Tags
Return values
bool|intdelete()
Löscht ein Objekt in der Datenbank
public
delete(
)
: bool
Return values
boolcreateFromDbObject()
Füllt Objekt mit Daten aus Datenbank-Result
public
createFromDbObject(
$object :
object
)
: bool
Parameters
- $object : object
Return values
boolgetPreparedSaveParams()
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften
protected
getPreparedSaveParams(
)
: array
Return values
arraygetPreparedValueParams()
Gibt array mit Values für Prepared Statements zurück
public
getPreparedValueParams(
[ $count :
int
= false ]
)
: int
Parameters
- $count : int = false
Return values
intprepareDataSave()
Bereitet Daten für Speicherung in Datenbank vor
public
prepareDataSave(
)
: bool
Tags
Return values
boolgetEditLink()
Gibt Link für Edit-Action zurück
public
getEditLink(
)
: string
Return values
stringgetEventName()
Returns full event name string
protected
final getEventName(
$event :
string
)
: string
Parameters
- $event : string
Tags
Return values
stringafterSaveInternal()
Is triggered after successful database insert
protected
afterSaveInternal(
)
: bool
Tags
Return values
boolafterUpdateInternal()
Is triggered after successful database update
protected
afterUpdateInternal(
)
: bool