Projekt: "EASY 2.0"

Funktionen der "functions.inc.php"

getCode(); return (String)

getCode(16);

getCode(16, 'user', 'uik');

getCode(16, array('user', 'sessions'), array('uik', 'ulc,sic'));

errormail();

errormail("Fehler beim erstellen von XY! Fehler in Klasse X => Funktion Y!");

Class "database"

public getTableInfo(); return (String)/(Array)

getTableInfo('user');

getTableInfo('user', 'Auto_increment');

getTableInfo('user', 'Auto_increment', 'example_ml_');

public getAmount(); return (String)

getAmount('user');

getAmount('user', 'username', 'max');

getAmount('user', '!username', 'max');

getAmount('user', array('first_name', 'active'), array('max', '1'));

Um mehrere Spalten überprüfen zu können, nutzen wir ein Array statt einem String. Auch hier können wir ein Ausrufezeichen (!) nutzen um Abfragen bestimmter Spalten zu invertieren. Dieser Code gibt uns die Anzahl aller Benutzer mit dem Vornamen "max" und die ein aktiviertes Konto haben.

Mit dem nächsten Parameter "$operator" geben wir den Operator an, mit welchem die einzelnen Bedingungen verknüpft werden. Standardmäßig ist "AND" gesetzt (also UND verknüpft). Hier können alle möglichen Operatoren eingesetzt werden.

getAmount('user', array('first_name', 'username'), 'max', "OR");

Hier bekommen wir alle die Anzahl aller Benutzer mit dem Vornamen oder Benutzernamen gleich "max". Bei dieser Schreibweise, werden alle Spalten (aus dem Array) mit dem String "max" verglichen.

Als letzter Parameter kann der Präfix der Tabellen geändert werden, so können auch Tabellen mit einem anderem Prefix auf der Datenbank erreicht werden.

public getValue(); return (String)/(Array)

Parameter: getValue(Tabelle, Spalte zur Selektion, Wert zur Selektion, Welche Spalten zurückgebeben werden sollen (default: NULL), Als Array zurückgeben(default: false), Zusatz Parameter Sortierung(default: ""), Verbund Operator(default: "AND"), Prefix(default: SystemPrefix));

getValue('user', NULL, NULL, NULL, true);

getValue('user', 'username', 'max', 'id');

Möchten wir alle IDs der Benutzer zurück bekommen, die als Benutzername "max" haben, so müssen wir den nächsten Parameter ($array) auf "true" setzen:

getValue('user', 'username', 'max', 'id', true);

So erhalten wir nun alle Benutzer IDs (als eindimensionales Array), welche den Benutzernamen "max" haben. Array[Datensatz];

Wollen wir mehr als nur die IDs der Benutzer haben, ersetzen wir den Parameter "$output" durch NULL:

getValue('user', 'username', 'max', NULL, true);

Wir bekommen ein zweidimensionales Array (Array[Datensatz][Spalte];) mit allen Benutzern, welche als Benutzernamen "max" haben, zurück.

Auch diese Funktion unterstützt die Nutzung von Array's (bei den Parametern "$column" und "$value") sowie den MySQL-Operatoren.

getValue('user', ['first_name', 'active'], ['max', '1'], NULL, true, 
"ORDER BY id DESC");

Mit dem Parameter "$sort" können wir noch etwas an die Abfrage anhängen. Zum Beispiel eine gewünschte Sortierung und/oder ein Limit setzen.

Als letzter Parameter kann der Präfix der Tabellen geändert werden, so können auch Tabellen mit einem anderem Prefix auf der Datenbank erreicht werden.

getValue('example', 'test', 'bsp', NULL, true, NULL, NULL, "");

Wenn wir den letzten Parameter auf "" setzen, überschreiben wir den Systemprefix für diese Abfrage. Somit werden uns alle Zeilen der Tabelle "example" zurückgegeben, welche in der Spalte "test" den Wert "bsp" stehen haben.

getValue('example', 'test', 'bsp', ['id', 'test'], true, NULL, NULL, "");

Aufbauend auf unserem vorherigen Beispiel, wollen wir hier nur zwei Spalten der Tabelle zurück bekommen. Hierfür setzen wir nun beim vierten Parameter ein Array mit den zwei gewünschten Spalten (id und test) ein.

getValue('example', '!test', 'bsp', ['id', 'test'], true, NULL, NULL, "");

In dem man vor dem Spaltennamen der zur Selektion der Daten dient, ein Ausrufezeichen (!) setzt, negieren wir die Abfrage. Somit erhalten wir nun alle Spalten der Tabelle "example" welche nicht "bsp" enthalten.

public getMainData(); return (String)

getMainData('site_title');

Wir geben in dem Parameter an, welche Einstellungsinformation wir abrufen möchten.

Class "captcha"

public generateCaptcha(); Gibt ein Bild zurück

<img src="./?captcha=img" onclick="this.src='./?captcha=img&generate='+Math.random()" 
title="Klicke um neuen Code zu erhalten">

Beispiel um ein Captcha einzubinden. Dazu kann der bereits vorhandene Link genutzt werden. Wichtig! Nur ein Captcha pro Seite einbinden! Sonst funktioniert die Überprüfung nicht korrekt!

public check_captcha(); return (Boolean)

$code = 'ABC1'; // Eingelesen
$captchaClass = new captcha();
if($captchaClass->check_captcha($code) == true){
	// Ausführung des gewünschten Codes
}

Beispiel um ein Captcha abzufragen.

Class "loginsystem" extends "database"

public pwverify(); return (Boolean)

pwverify($password); // $password = das einegebene Passwort

Die Funktion überprüft ob das übergebene Passwort identisch mit dem Passwort des aktuell angemeldeten Benutzers ist.

pwverify($password, $reference_password);

Mit Angabe des zweiten Parameters wird geprüft ob das eingelesene Passwort gleich dem Referenzpassworts ist. Das Referenzpasswort muss als Hash übergeben werden!

public pwhash(); return (String)

$pw_hash = $loginsystem->pwhash($password); // $password = das einegebene Passwort

Mit diesem Beispiel kann außerhalb der Klasse ein Passwort gehasht werden.

public login_session(); return (Boolean)

if($loginsystem->login_session() == true){ 
	// Ausführung des gewünschten Codes
}

Beispiel um außerhalb der Klasse zu prüfen ob der Benutzer eingeloggt ist.

public is_locked(); return (Boolean)

if($loginsystem->is_locked() == true){ 
	// Ausführung des gewünschten Codes
}

Beispiel um außerhalb der Klasse zu prüfen ob der Benutzer eingeloggt und die Oberfläche gesperrt ist.

public getUser(); return (String)/(Array)

getUser('username');

Gibt den Benutzernamen des aktuell angemeldeten Benutzers zurück. Mit dem ersten Parameter geben wir an, welche Information (Spalte) wir vom Benutzer zurück bekommen möchten.

getUser('username', $id);

Gibt den Benutzernamen des Benutzers mit der ID "$id" zurück. Der zweite Parameter legt fest, für welchen Benutzer wir Informationen erhalten möchten. Standardmäßig muss die ID des Benutzers angegeben werden. Möchten wir den Benutzer über eine andere Spalte identifizieren, so geben wir mit dem dritten Parameter an, mit welcher Spalte dies geschehen soll.

getUser('username', $uik, 'uik');

Gibt den Benutzernamen des Benutzers mit dem UserIdentificationKey (uik) "$uik" zurück.

getUser(NULL, NULL, NULL, true);

Geben wir den vierten Parameter an, können wir uns alle Daten des Benutzers als Array zurückgeben lassen. Hierbei ist es egal was im ersten Parameter übergeben wird. Mit den anderen Parametern kann weiterhin gearbeitet werden.

Es kann maximal Informationen für einen Benutzer zurückgeben werden!

public getData(); return (String)

getData('csrfToken');

So erhalten wir den aktuellen CSRF-Code des Benutzers, zum verwenden in Links oder zum überprüfen.
Weitere Daten mit dieser Funktion abzurufen, ist angedacht.

public check_password(); return (Boolean)

check_password($password); // $password = eingelesenes Passwort

public auditRight(); return (Boolean)

if($loginsystem->auditRight('user_add') == true){ 
	// Ausführung des gewünschten Codes
}

Mit dem ersten Paramter geben wir an, welches Recht (Regel) wir prüfen wollen. Dies gilt für den aktuell angemeldeten Benutzer. Hier prüfen wir das Recht (Regel) "user_add" ab. Wenn wir uns die Funktion nicht aus dem "Tag" ableiten können, schauen wir in die Regelverwaltung für was dieser steht.

if($loginsystem->auditRight('user_add', $id) == true){ 
	// Ausführung des gewünschten Codes
}

Mit dem zweiten Paramter geben wir an, für welchen Benutzer wir das Recht abfragen wollen. Dies muss nur angegeben werden, wenn wir das Recht für einen anderen Benutzer als aktuell angemeldeten wollen. Dazu muss die BenutzerID übergeben werden.

public getRank(); return (String)

getRank();

Übergeben wir keine Parameter, so wird der Rang(Name) des aktuellen Benutzers zurückgegeben. Wollen wir den Rang für einen anderen Benutzer erhalten, so geben wir den ersten Parameter an.

getRank($userID);

Wir erhalten den Rang des Benutzers mit der ID "$userID" zurück.
Mit dem zweiten Parameter können wir bestimmen ob wir den Rang mit seinem Style zurück bekommen möchten.

getRank(NULL, true);

Gibt uns den Rang mit dem jeweiligen Style zurück. Wir können aber auch einen selbst mitgelieferten String den Style anpassen.

getRank(NULL, true, $string); // $string könnte z.B. der Benutzername sein

So erhalten wir den übergeben String in dem Style des Rangs vom aktuellen Benutzer.

getRank($rankID, NULL, NULL, true);

Mit dem vierten Parameter können wir auch die Ausgabe eines beliebigen Ranges erhalten. So übergeben wir statt der BenutzerID nun die RangID als ersten Parameter.

public sendMail(); return (Boolean)

$data["subject"] = "Eine Testmail";
$data["fullname"] = 'Fritz Meier';
$to = 'fritz.meier@example.de';
if($loginsystem->sendMail('meineMail.html', NULL, $data, $to)){
	// Meldung Mail erfolgreich verschickt
}

Der erste Parameter gibt an, welches HTML-Template wir nutzen wollen. Diese befinden sich im Verzeichnis "emailtpl". (Wie erstelle ich ein Mail-Template?) In unserem Fall ist das "meineMail.html". Der zweite Parameter hat noch keine Verwendung (folgt noch). Im dritten Parameter übergeben wir Daten die wir ersetzen wollen. Mit den Keys des Arrays geben wir den Platzhalter an welchen wir in dem Template verwenden und werden durch die Werte gesetzt. Allerdings übergeben wir damit auch den Betreff (Engl. Subject) der Mail. Der vierte Parameter übergibt die E-Mail Adresse des Empfängers. (Wird dieser leer gelassen, so wird die E-Mail zur Administrator E-Mail Adresse [aus den Einstellungen] geschickt)

Als fünften Parameter können wir noch eine E-Mail Adresse anegeben, an die eine Antwort geschickt wird, wenn der Benutzer auf diese E-Mail antworten sollte. Beilbt dieser Parameter frei, wird die E-Mail Adresse aus den Einstellungen verwendet.

Mit dem sechsten und siebten Parameter können noch andere Header/Footer Dateien ausgewählt werden. Denn die E-Mails bestehen aus drei Dateien. Header, "Body" (z.B. 'meineMail.html') und der Footer Datei.

Class "sites" extends "loginsystem"

public getSiteName(); return (String)

Class "menu" extends "sites"

public getMenu(); return (String)

$menu->getMenu(NULL, 'neu');

Mit dem zweiten Parameter können wir ein alternatives Verzeichnis angeben. So ist es uns möglich andere Template-Dateien zu nutzen. Diese befinden sich im Verzeichnis: ./system/tpl/menu/
Der erste Parameter hat noch keine Verwendung.