Documentation

author extends dataset
in package
Uses autoTable

Benutzer Objekt

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2011-2020, Stefan Seehafer

license

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

Table of Contents

AUTHOR_ERROR_DISABLED  = -4
Error-Code: Benutzer ist deaktiviert
AUTHOR_ERROR_EXISTS  = -1
Error-Code: Benutzer existiert
AUTHOR_ERROR_NOEMAIL  = -3
Error-Code: Keine E-Mail-Adresse angegeben
AUTHOR_ERROR_PASSWORDINSECURE  = -2
Error-Code: Passwort ist unsicher
$authtoken  : string
Two factor auth token
$cache  : cache
System-Cache
$cacheName  : string
Cache name
$changetime  : int
Time of last change
$changeuser  : int
User of last change
$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>
Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen
$disabled  : int
Deaktiviert
$displayname  : string
Anzeigeter Name
$editAction  : string
Edit action string
$email  : string
E-Mail-Adresse
$events  : events
Event-Liste
$groupname  : string
Übersetzter Gruppenname
$id  : int
Objekt-ID
$image  : string
Authoren-Bild
$language  : language
System-Sprachen-Objekt
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$passwd  : string
sha256-Hash des Passwortes
$registertime  : int
Zeit, an dem der Benutzer angelegt wurde
$roll  : int
Benutezrrolle
$session  : session
System-Session
$table  : string
Tabellen-Name
$username  : string
Benutzername
$usrinfo  : string
Author-Beschreibung
$usrmeta  : string
Meta-Daten für persönliche Einstellungen
$wordbanList  : items
Wortsperren-Liste
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : bool
Löscht ein Objekt in der Datenbank
disable()  : bool
Deaktiviert einen Benutzer
disablePasswordSecCheck()  : mixed
Passwort-Check ein Anlegen/Aktualisieren deaktivieren
enable()  : bool
Aktiviert einen Benutzer
exists()  : bool
Prüft ob Objekt existiert
getAuthorImageDataOrPath()  : string
Author-Bild laden
getAuthtoken()  : string
Fetch auth token
getChangeTime()  : int
Returns change time
getChangeUser()  : int
Return change user
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getDisabled()  : bool
Status ob Benutzer deaktiviert ist auslesen
getDisplayname()  : string
Liefert anzeigten Name zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getEmail()  : string
Liefert E-Mail-Adresse zurück
getGroupname()  : string
Übersetzter Gruppenname
getId()  : int
Gibt Object-ID zurück
getImage()  : mixed
Author-Bild zurückliefern
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPasswd()  : string
Liefert Passwort-Hash zurück
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getRegistertime()  : int
Liefert Datum der Anmeldung zurück
getRoll()  : string
Liefert Rollen-ID zurück
getTableName()  : string
Returns table name based on class name
getUserMeta()  : string|array<string|int, mixed>
Liefert ben.-def. Einstellungen zurück
getUsername()  : string
Liefert Benutzername zurück
getUsrinfo()  : mixed
Kurze Authoren-Beschreibung setzen
init()  : bool
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
isAdmin()  : bool
ist Benutzer ein Administrator
overrideConfig()  : mixed
Override config object with global settings
passwordSecCheckDisabled()  : mixed
Passwort-Check ein Anlegen/Aktualisieren deaktivieren
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
readOption()  : mixed
Read content from file option for current user
removeOption()  : mixed
Removes file option for current user
resetDashboard()  : bool
Reset Dashboard container settings
resetPassword()  : bool
Passwort für Benutzer zurücksetzen
resetProfileSettings()  : bool
Reset Profile settings
save()  : bool
Speichert einen neuen Benutzer in der Datenbank
setAuthtoken()  : mixed
Set auth token data
setChangeTime()  : $this
Returns time of last change
setChangeUser()  : $this
Returns user of last change
setDisabled()  : mixed
Deaktiviert-Status setzen
setDisplayName()  : mixed
Angezeigten Name setzen
setEmail()  : mixed
E-Mail-Adresse setzen
setId()  : mixed
Set dataset id
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setPassword()  : mixed
Passwort-Hash setzen
setRegistertime()  : mixed
Anmelde-Datum setzen
setRoll()  : mixed
Rollen-ID setzen
setUserMeta()  : mixed
ben.-def. Einstellungen setzen
setUserName()  : mixed
Benutzername setzen
setUsrinfo()  : mixed
Kurze Authoren-Beschreibung setzen
update()  : bool
Aktualisiert einen Benutzer in der Datenbank
writeOption()  : bool
Write content to file option for current user
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
removeBannedTexts()  : bool
Führt Ersetzung von gesperrten Texten in Benutzer-Daten durch
authorExists()  : bool
Prüft, ob Benutzer existiert
checkPasswordSecure()  : bool
Prüft, ob Passwort den minimalen Anforderungen entspricht
getFileOptionObject()  : string
Generates file option object for current user

Constants

AUTHOR_ERROR_DISABLED

Error-Code: Benutzer ist deaktiviert

public mixed AUTHOR_ERROR_DISABLED = -4

AUTHOR_ERROR_EXISTS

Error-Code: Benutzer existiert

public mixed AUTHOR_ERROR_EXISTS = -1

AUTHOR_ERROR_NOEMAIL

Error-Code: Keine E-Mail-Adresse angegeben

public mixed AUTHOR_ERROR_NOEMAIL = -3

AUTHOR_ERROR_PASSWORDINSECURE

Error-Code: Passwort ist unsicher

public mixed AUTHOR_ERROR_PASSWORDINSECURE = -2

Properties

$authtoken

Two factor auth token

protected string $authtoken = ''
Tags
since
4

$cacheName

Cache name

protected string $cacheName = false

$changetime

Time of last change

protected int $changetime = 0

$changeuser

User of last change

protected int $changeuser = 0

$data

data-Array für nicht weiter definierte Eigenschaften

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

$dbExcludes

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

protected array<string|int, mixed> $dbExcludes = ['groupname', 'image']

$disabled

Deaktiviert

protected int $disabled

$displayname

Anzeigeter Name

protected string $displayname

$editAction

Edit action string

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

$email

E-Mail-Adresse

protected string $email

$groupname

Übersetzter Gruppenname

protected string $groupname
Tags
since
3.4

$image

Authoren-Bild

protected string $image = ''
Tags
since
3.6

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$passwd

sha256-Hash des Passwortes

protected string $passwd

$registertime

Zeit, an dem der Benutzer angelegt wurde

protected int $registertime

$roll

Benutezrrolle

protected int $roll

$table

Tabellen-Name

protected string $table

$username

Benutzername

protected string $username

$usrinfo

Author-Beschreibung

protected string $usrinfo = ''
Tags
since
3.6

$usrmeta

Meta-Daten für persönliche Einstellungen

protected string $usrmeta = ''

$wordbanList

Wortsperren-Liste

protected items $wordbanList
Tags
since
3.2.0

Methods

__construct()

Konstruktor

public __construct([int $id = null ]) : void
Parameters
$id : int = null
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

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

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

delete()

Löscht ein Objekt in der Datenbank

public delete() : bool
Return values
bool

disable()

Deaktiviert einen Benutzer

public disable() : bool
Return values
bool

disablePasswordSecCheck()

Passwort-Check ein Anlegen/Aktualisieren deaktivieren

public disablePasswordSecCheck() : mixed
Return values
mixed

enable()

Aktiviert einen Benutzer

public enable() : bool
Return values
bool

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getAuthorImageDataOrPath()

Author-Bild laden

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

getAuthtoken()

Fetch auth token

public getAuthtoken() : string
Return values
string

getChangeTime()

Returns change time

public getChangeTime() : int
Return values
int

getChangeUser()

Return change user

public getChangeUser() : int
Return values
int

getData()

Gibt Inhalt von "data" zurück

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

getDisabled()

Status ob Benutzer deaktiviert ist auslesen

public getDisabled() : bool
Return values
bool

getDisplayname()

Liefert anzeigten Name zurück

public getDisplayname() : string
Return values
string

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string

getEmail()

Liefert E-Mail-Adresse zurück

public getEmail() : string
Return values
string

getGroupname()

Übersetzter Gruppenname

public getGroupname() : string
Tags
since
3.4
Return values
string

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getImage()

Author-Bild zurückliefern

public getImage() : mixed
Tags
since
3.6
Return values
mixed

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata() : bool
Return values
bool

getPasswd()

Liefert Passwort-Hash zurück

public getPasswd() : string
Return values
string

getPreparedValueParams()

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

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

getRegistertime()

Liefert Datum der Anmeldung zurück

public getRegistertime() : int
Return values
int

getRoll()

Liefert Rollen-ID zurück

public getRoll() : string
Return values
string

getTableName()

Returns table name based on class name

public final getTableName() : string
Tags
since
4.5
Return values
string

getUserMeta()

Liefert ben.-def. Einstellungen zurück

public getUserMeta([string $valueName = null ]) : string|array<string|int, mixed>
Parameters
$valueName : string = null
Return values
string|array<string|int, mixed>

getUsername()

Liefert Benutzername zurück

public getUsername() : string
Return values
string

getUsrinfo()

Kurze Authoren-Beschreibung setzen

public getUsrinfo() : mixed
Tags
since
3.6
Return values
mixed

init()

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

public init() : bool
Return values
bool

isAdmin()

ist Benutzer ein Administrator

public isAdmin() : bool
Return values
bool

overrideConfig()

Override config object with global settings

public overrideConfig() : mixed
Return values
mixed

passwordSecCheckDisabled()

Passwort-Check ein Anlegen/Aktualisieren deaktivieren

public passwordSecCheckDisabled() : mixed
Return values
mixed

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

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

readOption()

Read content from file option for current user

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

removeOption()

Removes file option for current user

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

resetDashboard()

Reset Dashboard container settings

public resetDashboard() : bool
Tags
since
4.1
Return values
bool

resetPassword()

Passwort für Benutzer zurücksetzen

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

(@since FPCM3.4)

Return values
bool

resetProfileSettings()

Reset Profile settings

public resetProfileSettings() : bool
Tags
since
4.1
Return values
bool

save()

Speichert einen neuen Benutzer in der Datenbank

public save() : bool
Return values
bool

setAuthtoken()

Set auth token data

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

setChangeTime()

Returns time of last change

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

setChangeUser()

Returns user of last change

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

setDisabled()

Deaktiviert-Status setzen

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

setDisplayName()

Angezeigten Name setzen

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

setEmail()

E-Mail-Adresse setzen

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

setId()

Set dataset id

public setId(int $id) : mixed
Parameters
$id : 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

setPassword()

Passwort-Hash setzen

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

setRegistertime()

Anmelde-Datum setzen

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

setRoll()

Rollen-ID setzen

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

setUserMeta()

ben.-def. Einstellungen setzen

public setUserMeta(array<string|int, mixed> $usrmeta) : mixed
Parameters
$usrmeta : array<string|int, mixed>
Return values
mixed

setUserName()

Benutzername setzen

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

setUsrinfo()

Kurze Authoren-Beschreibung setzen

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

update()

Aktualisiert einen Benutzer in der Datenbank

public update() : bool
Return values
bool

writeOption()

Write content to file option for current user

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

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal() : bool
Tags
see
dataset::afterSaveInternal
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 getEventModule() : string
Tags
see
dataset::getEventModule
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>

removeBannedTexts()

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

protected removeBannedTexts() : bool
Tags
since
3.2.0
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

getFileOptionObject()

Generates file option object for current user

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

Search results