SecDoc

Documentation

Packages

Application

Interfaces, Classes, Traits and Enums

Auth
Abstrakte Klasse als Vorlage für Authentifizierungsmethoden.
demoAuth
Klasse zur Implementierung der Demo-Authentifizierung.
ldapAuth
Klasse zur Implementierung der LDAP-Authentifizierung.
openidAuth
Klasse zur Implementierung der openid-Authentifizierung.
ssoAuth
Klasse zur Implementierung der SSO-Authentifizierung.
DBCon
SQLite Datenbank Schnittstelle für die Verfahrensverwaltung und zur Abfrage von Ausfüllhinweisen
demoDocMGMT
Klasse zur Implementierung einer Demo-Dateiverwaltung (ohne tatsächliche Speicherung der Dateien).
DocMGMT
Abstrakte Klasse als Vorlage zur Dokumentenverwaltung.
localDocMGMT
Klasse zur Implementierung einer lokalen Dateiverwaltung.
Utils
Bündelt Hilfsfunktionen, die teilweise externe Ressourcen nutzen müssen.

Table of Contents

php_error_handler()  : bool
Eigene Fehlerbehandlung
customExceptionHandler()  : void
Fängt eine Exception ab und gibt eine Nutzerfreundliche Meldung zurück. Die Meldung selbst wird in der Variable $output['debug'] ausgegeben, wenn das Debugging eingeschaltet ist.
generateTXT()  : bool
Generiert eine Textdatei, um als SSI genutzt zu werden.
generatePDF()  : bool
Generiert eine PDF-Datei aus dem übergebenen HTML-Code.
generateCombinedPDF()  : bool
Generiert eine kombinierte PDF-Datei mit allen PDFs von abgeschlossenen Verarbeitungstätigkeiten (VVT).
generatePrivacyPolicyPDF()  : bool
Generiert eine Datenschutzerklärung aus einer Dokumentation.
generateCompletePDF()  : bool
Erstellt eine komplette PDF-Dokumentation einer Verarbeitungstätigkeit mit allen Abhängigkeiten.
generateEmail()  : bool
Generiert eine E-Mail an die eingetragenen Verantwortlichen mit PDF-Datei des Verfahrens als Anhang.
sendNotificationEmail()  : bool
Verschickt eine Benachrichtigung über angeforderte Hilfe bei der Bearbeitung.
returnError()  : void
Gibt eine Fehlermeldung im einheitlichen Format zurück und beendet die Ausführung danach (genutzt für fehlerhafte Aufrufe).
sql_personen_table()  : mixed
Personen-Tabelle mit Mitarbeitern und Stud. Hilfskräften füllen.
sql_mitarbeiter_table()  : mixed
Liste der Mitarbeiter sowie Adresse, Tel. und E-Mail holen.
sql_studhilfskraefte_table()  : mixed
Liste der Stud. Mitarbeiter mit Name holen.
sql_ivven_table()  : mixed
Liste der IVVen holen (Tabelle V_NETZ).
sql_organisationseinheiten_table()  : mixed
Liste der Organisationseinheiten mit Adresse holen (Tabelle WWUBEN.INSTITUTS_ADRESSEN).
sql_organisationseinheiten_table2()  : mixed
Liste der Organisationseinheiten mit Adresse holen (Tabelle ALT_INSTITUTE/PROJEKTE).
sql_organisationseinheiten_table3()  : mixed
Liste der Organisationseinheiten holen (Tabelle V_NETZ).
sql_organisationseinheiten_table4()  : mixed
Liste der Organisationseinheiten holen (Tabelle PUBLIC_ETB).

Functions

php_error_handler()

Eigene Fehlerbehandlung

php_error_handler(number $errno, string $errstr, string $errfile, number $errline) : bool
Parameters
$errno : number

Fehlernummer

$errstr : string

Fehlerbeschreibung

$errfile : string

Skript in dem der Fehler auftrat

$errline : number

Zeile in welcher der Fehler auftrat

Return values
bool

customExceptionHandler()

Fängt eine Exception ab und gibt eine Nutzerfreundliche Meldung zurück. Die Meldung selbst wird in der Variable $output['debug'] ausgegeben, wenn das Debugging eingeschaltet ist.

customExceptionHandler(Exception $exception) : void
Parameters
$exception : Exception

Geworfene Exception

Tags
global

bool $debug Debug-Einstellung

global

string $userId Nutzerkennung des aktuellen Nutzers

global

array $userGroups Nutzergruppen des aktuellen Nutzers

global

array $debugGroups Nutzergruppen, die Fehlermeldungen anzeigen dürfen

Return values
void

generateTXT()

Generiert eine Textdatei, um als SSI genutzt zu werden.

generateTXT(DBCon $dbcon, string $userId, array<string|int, mixed> $userGroups, bool $userIsDSB, int $verfahrensId) : bool
Parameters
$dbcon : DBCon

Datenbank-Verbindung als PDO Objekt

$userId : string

Nutzerkennung

$userGroups : array<string|int, mixed>

Nutzergruppen

$userIsDSB : bool

DSB-Berechtigung

$verfahrensId : int

ID des zu exportierenden Verfahrensverzeichnisses

Tags
author

Marius Timmer marius.timmer@uni-muenster.de

global

string $includes_dir Verzeichnis für Textdateien

Return values
bool

True bei Erfolg sonst false

generatePDF()

Generiert eine PDF-Datei aus dem übergebenen HTML-Code.

generatePDF(string $title, string $html, int $verfahrensId[, bool $isDraft = FALSE ]) : bool
Parameters
$title : string

Titel des Verfahrens

$html : string

HTML-Code, der als PDF gerendert werden soll

$verfahrensId : int

ID des zu exportierenden Verfahrensverzeichnisses

$isDraft : bool = FALSE

(optional) Erstellt eine Vorschau-PDF bei TRUE

Tags
author

Dustin Gawron dustin.gawron@uni-muenster.de

global

string $pdf_dir Verzeichnis für die PDF-Speicherung

Return values
bool

True bei Erfolg sonst false

generateCombinedPDF()

Generiert eine kombinierte PDF-Datei mit allen PDFs von abgeschlossenen Verarbeitungstätigkeiten (VVT).

generateCombinedPDF(array<string|int, mixed> $processes) : bool
Parameters
$processes : array<string|int, mixed>

Array von Verfahren (wie von DBCon->listVerfahrenDSB() zurückgegeben)

Return values
bool

TRUE bei Erfolg (PDF wurde in $pdf_dir abgespeichert), FALSE sonst

generatePrivacyPolicyPDF()

Generiert eine Datenschutzerklärung aus einer Dokumentation.

generatePrivacyPolicyPDF(int $verfahrensId) : bool
Parameters
$verfahrensId : int

ID der Dokumentation

Return values
bool

TRUE bei Erfolg, sonst FALSE

generateCompletePDF()

Erstellt eine komplette PDF-Dokumentation einer Verarbeitungstätigkeit mit allen Abhängigkeiten.

generateCompletePDF(array<string|int, mixed> $process, array<string|int, mixed> $procDep, array<string|int, mixed> $appDep, array<string|int, mixed> $itDep, array<string|int, mixed> $infraDep, array<string|int, mixed> $measuresDep) : bool
Parameters
$process : array<string|int, mixed>

Array der Hauptverarbeitungstätigkeit

$procDep : array<string|int, mixed>

Array der Abhängigkeiten von Verarbeitungstätigkeiten

$appDep : array<string|int, mixed>

Array der Abhängigkeiten von Fachapplikationen

$itDep : array<string|int, mixed>

Array der Abhängigkeiten von IT-Systemen

$infraDep : array<string|int, mixed>

Array der Abhängigkeiten von Infrastruktur

$measuresDep : array<string|int, mixed>

Array der Abhängigkeiten von übergreifenden Massnahmen

Return values
bool

TRUE bei Erfolg, sonst FALSE

generateEmail()

Generiert eine E-Mail an die eingetragenen Verantwortlichen mit PDF-Datei des Verfahrens als Anhang.

generateEmail(DBCon $dbcon, string $userId, array<string|int, mixed> $userGroups, bool $userIsDSB, int $verfahrensId, string $revComment) : bool
Parameters
$dbcon : DBCon

Datenbank-Verbindung als PDO Objekt

$userId : string

Nutzerkennung

$userGroups : array<string|int, mixed>

Nutzergruppen

$userIsDSB : bool

DSB-Berechtigung

$verfahrensId : int

ID des zu exportierenden Verfahrensverzeichnisses

$revComment : string
Tags
author

Victor Nellißen vinellis@uni-mainz.de

global

string $pdf_dir Verzeichnis für die PDF-Speicherung

global

array $eMail_config Konfiguration für den E-Mail Versand

Return values
bool

True bei Erfolg sonst false

sendNotificationEmail()

Verschickt eine Benachrichtigung über angeforderte Hilfe bei der Bearbeitung.

sendNotificationEmail(array<string|int, mixed> $verfahrensInfo, string $currEditorID, string $nextEditorID, string $editorComment) : bool
Parameters
$verfahrensInfo : array<string|int, mixed>

Informationen über die Dokumentation

$currEditorID : string

Nutzerkennung des aktuellen Bearbeiters

$nextEditorID : string

Nutzerkennung des nächsten Bearbeiters

$editorComment : string

Aktueller Bearbeitungskommentar

Tags
global

string $prog_url SecDoc-URL

global

array $eMail_config Konfiguration für den E-Mail Versand

Return values
bool

TRUE bei Erfolg, sonst FALSE

returnError()

Gibt eine Fehlermeldung im einheitlichen Format zurück und beendet die Ausführung danach (genutzt für fehlerhafte Aufrufe).

returnError(string $msg) : void
Parameters
$msg : string

Fehlermeldung

Tags
global

bool $debug

global

string $userId Nutzerkennung

global

array $userGroups Nutzergruppen des aktuellen Nutzers

global

array $debugGroups Nutzergruppen, die Fehlermeldungen anzeigen dürfen

Return values
void

sql_personen_table()

Personen-Tabelle mit Mitarbeitern und Stud. Hilfskräften füllen.

sql_personen_table() : mixed
Return values
mixed

sql_mitarbeiter_table()

Liste der Mitarbeiter sowie Adresse, Tel. und E-Mail holen.

sql_mitarbeiter_table() : mixed
Return values
mixed

sql_studhilfskraefte_table()

Liste der Stud. Mitarbeiter mit Name holen.

sql_studhilfskraefte_table() : mixed
Return values
mixed

sql_ivven_table()

Liste der IVVen holen (Tabelle V_NETZ).

sql_ivven_table() : mixed
Tags
global

type $oci_handle Globaler Datenbank-Handle

Return values
mixed

sql_organisationseinheiten_table()

Liste der Organisationseinheiten mit Adresse holen (Tabelle WWUBEN.INSTITUTS_ADRESSEN).

sql_organisationseinheiten_table() : mixed
Tags
global

type $oci_handle Gloabler Datenbank-Handle

Return values
mixed

sql_organisationseinheiten_table2()

Liste der Organisationseinheiten mit Adresse holen (Tabelle ALT_INSTITUTE/PROJEKTE).

sql_organisationseinheiten_table2() : mixed
Tags
global

type $oci_handle Globaler Datenbank-Handle

Return values
mixed

sql_organisationseinheiten_table3()

Liste der Organisationseinheiten holen (Tabelle V_NETZ).

sql_organisationseinheiten_table3() : mixed
Tags
global

type $oci_handle Globaler Datenbank-Handle

Return values
mixed

sql_organisationseinheiten_table4()

Liste der Organisationseinheiten holen (Tabelle PUBLIC_ETB).

sql_organisationseinheiten_table4() : mixed
Tags
global

type $oci_handle Globaler Datenbank-Handle

Return values
mixed

Search results