Documentation

authProvider extends model
in package

authProvider base class

Tags
abstract
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

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

Table of Contents

AUTH_2FA_ERROR  = -400
$cache  : cache
System-Cache
$cacheModule  : string
Cache name
$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>
Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen
$editAction  : string
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$table  : string
Tabellen-Name
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
authenticate()  : mixed
Execute authentication
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : bool
Löscht ein Objekt in der Datenbank
exists()  : bool
Prüft ob Objekt existiert
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getId()  : int
Gibt Object-ID zurück
getLoginTemplate()  : string
Return template for active auth provider
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
init()  : bool
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
twoFactorAuth()  : bool
Runs additional two 2FA-checks
getPreparedSaveParams()  : array<string|int, mixed>
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften

Constants

Properties

$cacheModule

Cache name

protected string $cacheModule = ''

$cacheName

Cache name

protected string $cacheName = false

$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 = []

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$id

Objekt-ID

protected int $id

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$table

Tabellen-Name

protected string $table

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

authenticate()

Execute authentication

public abstract authenticate(array<string|int, mixed> $param) : mixed
Parameters
$param : array<string|int, mixed>
Return values
mixed

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

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getData()

Gibt Inhalt von "data" zurück

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

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getLoginTemplate()

Return template for active auth provider

public abstract getLoginTemplate() : string
Return values
string

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

init()

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

public init() : bool
Return values
bool

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

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

setNodata()

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

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

twoFactorAuth()

Runs additional two 2FA-checks

public twoFactorAuth(mixed $param) : bool
Parameters
$param : mixed
Return values
bool

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