Documentation

author extends dataset
in
Uses autoTable

Benutzer Objekt

Table of Contents

AUTHOR_ERROR_EXISTS Error-Code: Benutzer existiert -1
AUTHOR_ERROR_PASSWORDINSECURE Error-Code: Passwort ist unsicher -2
AUTHOR_ERROR_NOEMAIL Error-Code: Keine E-Mail-Adresse angegeben -3
AUTHOR_ERROR_DISABLED Error-Code: Benutzer ist deaktiviert -4
$displayname Anzeigeter Name string
$email E-Mail-Adresse string
$registertime Zeit, an dem der Benutzer angelegt wurde int
$username Benutzername string
$passwd sha256-Hash des Passwortes string
$roll Benutezrrolle int
$disabled Deaktiviert int
$usrmeta Meta-Daten für persönliche Einstellungen string
$usrinfo Author-Beschreibung string
$authtoken Two factor auth token string
$changetime Time of last change int
$changeuser User of last change int
$groupname Übersetzter Gruppenname string
$image Authoren-Bild string
$editAction Edit action string string
$wordbanList Wortsperren-Liste items
$dbExcludes Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen array
$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() Konstruktor void
getDisplayname() Liefert anzeigten Name zurück string
getEmail() Liefert E-Mail-Adresse zurück string
getRegistertime() Liefert Datum der Anmeldung zurück int
getUsername() Liefert Benutzername zurück string
getPasswd() Liefert Passwort-Hash zurück string
getRoll() Liefert Rollen-ID zurück string
setRoll() Rollen-ID setzen mixed
getDisabled() Status ob Benutzer deaktiviert ist auslesen bool
getChangeTime() Returns change time int
getChangeUser() Return change user int
getGroupname() Übersetzter Gruppenname string
getUsrinfo() Kurze Authoren-Beschreibung setzen mixed
getImage() Author-Bild zurückliefern mixed
setDisabled() Deaktiviert-Status setzen mixed
getUserMeta() Liefert ben.-def. Einstellungen zurück string|array
getAuthtoken() Fetch auth token string
isAdmin() ist Benutzer ein Administrator bool
setDisplayName() Angezeigten Name setzen mixed
setEmail() E-Mail-Adresse setzen mixed
setRegistertime() Anmelde-Datum setzen mixed
setUserName() Benutzername setzen mixed
setPassword() Passwort-Hash setzen mixed
setUserMeta() ben.-def. Einstellungen setzen mixed
setUsrinfo() Kurze Authoren-Beschreibung setzen mixed
setChangeTime() Returns time of last change $this
setChangeUser() Returns user of last change $this
setAuthtoken() Set auth token data mixed
save() Speichert einen neuen Benutzer in der Datenbank bool
update() Aktualisiert einen Benutzer in der Datenbank bool
disable() Deaktiviert einen Benutzer bool
enable() Aktiviert einen Benutzer bool
disablePasswordSecCheck() Passwort-Check ein Anlegen/Aktualisieren deaktivieren mixed
passwordSecCheckDisabled() Passwort-Check ein Anlegen/Aktualisieren deaktivieren mixed
resetPassword() Passwort für Benutzer zurücksetzen bool
resetProfileSettings() Reset Profile settings bool
resetDashboard() Reset Dashboard container settings bool
createFromDbObject() Füllt Objekt mit Daten aus Datenbank-Result bool
authorExists() Prüft, ob Benutzer existiert bool
checkPasswordSecure() Prüft, ob Passwort den minimalen Anforderungen entspricht bool
removeBannedTexts() Führt Ersetzung von gesperrten Texten in Benutzer-Daten durch bool
init() Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde bool
writeOption() Write content to file option for current user bool
readOption() Read content from file option for current user mixed
removeOption() Removes file option for current user mixed
getFileOptionObject() Generates file option object for current user string
getAuthorImageDataOrPath() Author-Bild laden string
overrideConfig() Override config object with global settings mixed
getEventModule() Returns event base string string
afterSaveInternal() Is triggered after successful database insert bool
getTableName() Returns table name based on class name 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
getEventModule() Returns event base string string
afterSaveInternal() Is triggered after successful database insert bool
afterUpdateInternal() Is triggered after successful database update bool

Constants

AUTHOR_ERROR_EXISTS

Error-Code: Benutzer existiert

mixed $AUTHOR_ERROR_EXISTS = -1

AUTHOR_ERROR_PASSWORDINSECURE

Error-Code: Passwort ist unsicher

mixed $AUTHOR_ERROR_PASSWORDINSECURE = -2

AUTHOR_ERROR_NOEMAIL

Error-Code: Keine E-Mail-Adresse angegeben

mixed $AUTHOR_ERROR_NOEMAIL = -3

AUTHOR_ERROR_DISABLED

Error-Code: Benutzer ist deaktiviert

mixed $AUTHOR_ERROR_DISABLED = -4

Properties

$displayname

Anzeigeter Name

protected string $displayname

$email

E-Mail-Adresse

protected string $email

$registertime

Zeit, an dem der Benutzer angelegt wurde

protected int $registertime

$username

Benutzername

protected string $username

$passwd

sha256-Hash des Passwortes

protected string $passwd

$roll

Benutezrrolle

protected int $roll

$disabled

Deaktiviert

protected int $disabled

$usrmeta

Meta-Daten für persönliche Einstellungen

protected string $usrmeta = ''

$usrinfo

Author-Beschreibung

protected string $usrinfo = ''

$authtoken

Two factor auth token

protected string $authtoken = ''

$changetime

Time of last change

protected int $changetime = ""

$changeuser

User of last change

protected int $changeuser = ""

$groupname

Übersetzter Gruppenname

protected string $groupname

$image

Authoren-Bild

protected string $image = ''

$editAction

Edit action string

protected string $editAction = 'users/edit&id='

$wordbanList

Wortsperren-Liste

protected items $wordbanList

$dbExcludes

Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen

protected array $dbExcludes = ['groupname', 'image']

$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

$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()

Konstruktor

public __construct( [ $id : int = null ] ) : void
Parameters
$id : int = null

getDisplayname()

Liefert anzeigten Name zurück

public getDisplayname( ) : string
Return values
string

getEmail()

Liefert E-Mail-Adresse zurück

public getEmail( ) : string
Return values
string

getRegistertime()

Liefert Datum der Anmeldung zurück

public getRegistertime( ) : int
Return values
int

getUsername()

Liefert Benutzername zurück

public getUsername( ) : string
Return values
string

getPasswd()

Liefert Passwort-Hash zurück

public getPasswd( ) : string
Return values
string

getRoll()

Liefert Rollen-ID zurück

public getRoll( ) : string
Return values
string

setRoll()

Rollen-ID setzen

public setRoll( $roll : int ) : mixed
Parameters
$roll : int
Return values
mixed

getDisabled()

Status ob Benutzer deaktiviert ist auslesen

public getDisabled( ) : bool
Return values
bool

getChangeTime()

Returns change time

public getChangeTime( ) : int
Return values
int

getChangeUser()

Return change user

public getChangeUser( ) : int
Return values
int

getGroupname()

Übersetzter Gruppenname

public getGroupname( ) : string
Tags
since
Return values
string

getUsrinfo()

Kurze Authoren-Beschreibung setzen

public getUsrinfo( ) : mixed
Tags
since
Return values
mixed

getImage()

Author-Bild zurückliefern

public getImage( ) : mixed
Tags
since
Return values
mixed

setDisabled()

Deaktiviert-Status setzen

public setDisabled( $disabled : bool ) : mixed
Parameters
$disabled : bool
Return values
mixed

getUserMeta()

Liefert ben.-def. Einstellungen zurück

public getUserMeta( [ $valueName : string = null ] ) : string|array
Parameters
$valueName : string = null
Return values
string|array

getAuthtoken()

Fetch auth token

public getAuthtoken( ) : string
Return values
string

isAdmin()

ist Benutzer ein Administrator

public isAdmin( ) : bool
Return values
bool

setDisplayName()

Angezeigten Name setzen

public setDisplayName( $displayname : string ) : mixed
Parameters
$displayname : string
Return values
mixed

setEmail()

E-Mail-Adresse setzen

public setEmail( $email : string ) : mixed
Parameters
$email : string
Return values
mixed

setRegistertime()

Anmelde-Datum setzen

public setRegistertime( $registertime : string ) : mixed
Parameters
$registertime : string
Return values
mixed

setUserName()

Benutzername setzen

public setUserName( $username : string ) : mixed
Parameters
$username : string
Return values
mixed

setPassword()

Passwort-Hash setzen

public setPassword( $passwd : string ) : mixed
Parameters
$passwd : string
Return values
mixed

setUserMeta()

ben.-def. Einstellungen setzen

public setUserMeta( $usrmeta : array ) : mixed
Parameters
$usrmeta : array
Return values
mixed

setUsrinfo()

Kurze Authoren-Beschreibung setzen

public setUsrinfo( $usrinfo : string ) : mixed
Parameters
$usrinfo : string
Tags
since
Return values
mixed

setChangeTime()

Returns time of last change

public setChangeTime( $changetime : int ) : $this
Parameters
$changetime : int
Return values
$this

setChangeUser()

Returns user of last change

public setChangeUser( $changeuser : int ) : $this
Parameters
$changeuser : int
Return values
$this

setAuthtoken()

Set auth token data

public setAuthtoken( $authtoken : string ) : mixed
Parameters
$authtoken : string
Return values
mixed

save()

Speichert einen neuen Benutzer in der Datenbank

public save( ) : bool
Return values
bool

update()

Aktualisiert einen Benutzer in der Datenbank

public update( ) : bool
Return values
bool

disable()

Deaktiviert einen Benutzer

public disable( ) : bool
Return values
bool

enable()

Aktiviert einen Benutzer

public enable( ) : bool
Return values
bool

disablePasswordSecCheck()

Passwort-Check ein Anlegen/Aktualisieren deaktivieren

public disablePasswordSecCheck( ) : mixed
Return values
mixed

passwordSecCheckDisabled()

Passwort-Check ein Anlegen/Aktualisieren deaktivieren

public passwordSecCheckDisabled( ) : mixed
Return values
mixed

resetPassword()

Passwort für Benutzer zurücksetzen

public resetPassword( [ $resetOnly : bool = false ] ) : bool
Parameters
$resetOnly : bool = false

(@since FPCM3.4)

Return values
bool

resetProfileSettings()

Reset Profile settings

public resetProfileSettings( ) : bool
Tags
since
Return values
bool

resetDashboard()

Reset Dashboard container settings

public resetDashboard( ) : bool
Tags
since
Return values
bool

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

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

authorExists()

Prüft, ob Benutzer existiert

private authorExists( ) : bool
Return values
bool

checkPasswordSecure()

Prüft, ob Passwort den minimalen Anforderungen entspricht

private checkPasswordSecure( ) : bool
Return values
bool

removeBannedTexts()

Führt Ersetzung von gesperrten Texten in Benutzer-Daten durch

protected removeBannedTexts( ) : bool
Tags
since
Return values
bool

init()

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

public init( ) : bool
Return values
bool

writeOption()

Write content to file option for current user

public final writeOption( $opt : string , $data : mixed ) : bool
Parameters
$opt : string
$data : mixed
Return values
bool

readOption()

Read content from file option for current user

public final readOption( $opt : string ) : mixed
Parameters
$opt : string
Return values
mixed

removeOption()

Removes file option for current user

public final removeOption( $opt : string ) : mixed
Parameters
$opt : string
Return values
mixed

getFileOptionObject()

Generates file option object for current user

private getFileOptionObject( $opt : string ) : string
Parameters
$opt : string
Return values
string

getAuthorImageDataOrPath()

Author-Bild laden

public static getAuthorImageDataOrPath( $author : author [, $asUrl : bool = true ] ) : string
Parameters
$author : author
$asUrl : bool = true
Tags
since
Return values
string

overrideConfig()

Override config object with global settings

public overrideConfig( ) : mixed
Return values
mixed

getEventModule()

Returns event base string

protected getEventModule( ) : string
Tags
see
since
Return values
string

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal( ) : bool
Tags
see
since
Return values
bool

getTableName()

Returns table name based on class name

public final getTableName( ) : string
Tags
since
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
array

init()

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

public init( ) : bool
Return values
bool

getId()

Gibt Object-ID zurück

public getId( ) : int
Return values
int

setId()

Set dataset id

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

exists()

Prüft ob Objekt existiert

public exists( ) : bool
Return values
bool

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata( ) : bool
Return values
bool

setNodata()

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

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

save()

Executes save process to database and events

public save( ) : bool|int
Tags
since
Return values
bool|int

update()

Executes update process to database and events

public update( ) : bool|int
Tags
since
Return values
bool|int

delete()

Löscht ein Objekt in der Datenbank

public delete( ) : bool
Return values
bool

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

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

getPreparedSaveParams()

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

protected getPreparedSaveParams( ) : array
Return values
array

getPreparedValueParams()

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

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

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave( ) : bool
Tags
since
Return values
bool

getEditLink()

Gibt Link für Edit-Action zurück

public getEditLink( ) : string
Return values
string

getEventName()

Returns full event name string

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

getEventModule()

Returns event base string

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

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal( ) : bool
Tags
since
Return values
bool

afterUpdateInternal()

Is triggered after successful database update

protected afterUpdateInternal( ) : bool
Tags
since
Return values
bool

Search results