Plugin Tutorial für Einsteiger - 1.3 Daten Speichern und Lesen
Hallo Welt - 1.3 Variablen
In diesem Tutorial beschreiben wir verschiedene Möglichkeiten Daten in einem Plugin zu speichern und wieder auszulesen. Zur Startseite des Tutorials
Allgemeiner Hinweis: Es empfiehlt sich, dieses Tutorial in einem Testforum auszuprobieren, um den laufenden Betrieb im Hauptforum nicht zu beinträchtigen. Erstellen Sie dazu einfach bei Bedarf ein neues Forum unter www.xobor.de
Hinweis
Plugin Hallo Welt - Daten Speichern und Lesen
Beschreibung
Bisher beschränkten wir uns beim "Hallo Welt" Plugin ausschließlich auf die Ausgabe einfacher Texte. Für die meisten Plugins benötigt man jedoch auch die Möglichkeit, Daten zu Speichern und später wieder anzuzeigen.
Das wird über die Daten-Variablen (data Vars) oder die globalen Variablen (global Vars) realisiert.
Für diese Beispiel legen wir eine je eine Variable beider Typen an und erläutern deren Funktion.
Allgemeines
Unterschied zwischen data Vars und global Vars
Beide Variablentypen können verwendet werden um beliebige Arten von Daten zu speichern und später wieder auszugeben. Allerdings ist eine Daten-Variable immer einem bestimmten Inhalt des Forums zugeordnet. So kann man z.B. Daten speichern, die immer einem bestimmten Beitrag oder Benutzerprofil zugeordnet werden. Die Werte dieser Variablen stehen immer dann zur Verfügung, wenn das betroffene Element (also z.B. der Beitrag, zu dem die Variable gehört) gerade angezeigt wird.
Globale Variablen dagegen gelten für das gesamte Plugin und stehen auf jeder Seite des Forums zur Verfügung. Sie können z.B. verwendet werden, um Benutzereinstellungen zu einem Plugin zu speichern.
Wir das Forumlar für die "Neue Globale Variable" oder das Formular für eine "Neue Data Variable" geöffnet, haben beide Type zunächst die gleichen Grundeinstellungen:
Name: Der Name der neuen Variable
Parsing: Welche Art von Code ist erlaubt? BBCode? HTML?
Type: Welche Werte können gespeichert werden?
Rechteeinstellungen: Diverse Rechteeinstellungen, wer die Variable wann genau beschreiben/erstellen oder ändern darf.
Für Variablen gilt natürlich der gleiche Grundsatz wie im Forum auch:
Man sollte NIE den Mitgliedern ermöglichen, HTML abzuspeichern welches dann später im Forum ausgegeben wird. HTML sollte daher nur in Ausnahmefällen und nur für auschließlich vom Admin nutzbare Variablen erlaubt werden.
Hinweis
Hinweis: Neben einigen Standardwerten (Alle, Administratoren/Moderatoren etc.) kann auch eine Konfigurationsvariable vom Typ "grouprights" für die Rechtevergabe verwendet werden.
Das wird im nächsten Abschnitt des Tutorials genauer beschrieben: Grouprights Variablen
Das wird im nächsten Abschnitt des Tutorials genauer beschrieben: Grouprights Variablen
Hinweis
Bei den Data-Variablen gibt es zusätzlich noch zwei weitere Felder:
origin type: Hier wird festgelegt, welchem Element im Forum die Datenvariable zugeordnet ist. Soll ein Plugin z.B. Daten zu einem Beitrag speichern, wird hier der Typ "forum_post" ausgewählt.
userseparated: Diese Funktion befindet sich noch in der Betaphase. Wenn userseparated aktiviert wird, wird für jedes Mitglied eine eigene Datenvariable angelegt. Um beim Beispiel des "forum_posts" zu bleiben: Man könnte somit z.B. ein Plugin realisieren, bei dem jedes Mitglied seine eigenen Kommentare zu Beiträgen hinzufügen kann, die dann später auch nur von diesem Mitglied gelesen werden können.
Hallo Welt Beispiel - Globale Variable
Für dieses Tutorial wollen wir eine Variable anlegen die ausgibt wann zuletzt ein Administrator online war.
Plugin-Entwicklung --> Hallo Welt --> Neue globale Variable:
| Feldname | Wert |
|---|---|
| Name | adminonline |
| Hidden-Var | Nein (die Variable soll immer zur Verfügung stehen) |
| Parsing | Plain Text (BBCode und HTML wird hier nicht benötigt) |
| Type | Chars (es soll ja nur ein Datum gespeichert werden) |
| Lesen | Alle (jeder darf den Wert lesen) |
| Schreiben | Administrator (nur Admins dürfen den Wert ändern) |
Globale Variable Beschreiben
Jedesmal, wenn ein Administrator die Seite lädt, wollen wir die die aktuelle Uhrzeit in der globalen Variablen speichern.
Dazu nutzen wir die Javascript-Methode setGlob
Plugin-Dokumentation: setGlob-Funktion
Plugin API
für die Speicherung ersetzen wir den Code des Plugin-Templates "Test oben" mit folgedem Code:
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
{{user_admin==true.start}}
<script>
var newval = Date.now(); //erzeugt einen aktuellen Timestamp
xobor.plugin("hallowelt").setGlob("adminonline",newval,function(res){
/*Wert gespeichert, keine Ausgabe nötig*/
});
</script>
{{user_admin==true.end}}
Jetzt wird jedesmal, wenn ein Admin die Seite aufruft. der aktuelle Timestamp in der Variable adminonline gespeichert. Für nicht-Admins können wir das dann auslesen und anzeigen.
Das geschieht mit der getGlob Methode des Pluginsystems.
Globale Variable Lesen und Anzeigen
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{{user_admin==false.start}}
<div id="admininfo"><!--hier wird später der Wert der Variablen ausgegeben--></div>
<script>
lastonline = xobor.plugin('hallowelt').getGlob('adminonline');
if(lastonline){
timeFormat.displayFormat = 'd.m.Y H:i'; // gewünschtes format des datums
lastonline = timeFormat.format(lastonline); //hier erzuegen wir ein schön formatioertes Datum aus unserem Timestamp - details siehe spoiler unten..
console.log("last:" + lastonline);
$('#admininfo').html("Admin zuletzt online: " + lastonline); //hier wird der Wert in die Div mit der ID admininfo geschrieben
}else{/*Kein Admin war online, nichts ausgeben*/ console.log("nores");}
{{user_admin==false.end}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{{user_admin==true.start}}
<script>
var newval = Date.now(); //erzeugt einen aktuellen Timestamp
xobor.plugin("hallowelt").setGlob("adminonline",newval,function(res){
/*Wert gespeichert, keine Ausgabe nötig*/
});
</script>
{{user_admin==true.end}}
{{user_admin==false.start}}
<div id="admininfo"></div>
<script>
/**
* man muss ja nicht jedesmal das Rad neu erfinden: Diese Funktion wurde über Google gefunden und formatiert unser Datum im gewünschten Format:
* Return a timestamp with the format "d/m/yy h:MM:ss TT"
* @type {Date}
*/
var timeFormat = {
/**
* Output format.
*
* d - current day
* m - current month
* Y - current Year
*
* H - current hour (24 hour system)
* i - current minute
* s - current second
*/
displayFormat: 'd.m.Y - H:i:s',
/**
* Format given unix-timestamp
*/
format: function(timestamp) {
var d = new Date(timestamp);
var output = this.displayFormat;
output = output.replace(/d/g, this.padZero(d.getDate()))
.replace(/m/g, this.padZero(d.getMonth()+1))
.replace(/Y/g, d.getFullYear())
.replace(/H/g, this.padZero(d.getHours()))
.replace(/i/g, this.padZero(d.getMinutes()))
.replace(/s/g, this.padZero(d.getSeconds()));
return output;
},
/**
* add zero paddings to numbers smaller than 10
*/
padZero: function(number) {
if (number < 10) {
return "0" + number.toString();
}
return number;
}
};
lastonline = xobor.plugin('hallowelt').getGlob('adminonline');
if(lastonline){
timeFormat.displayFormat = 'd.m.Y H:i'; // gewünschtes format des datums
lastonline = timeFormat.format(lastonline); //hier erzuegen wir ein schön formatioertes Datum aus unserem Timestamp..
console.log("last:" + lastonline);
$('#admininfo').html("Admin zuletzt online: " + lastonline); //hier wird der Wert in die Div mit der ID admininfo geschrieben
}else{/*Kein Admin war online, nichts ausgeben*/ console.log("nores");}
</script>
{{user_admin==false.end}}
Abbildung 1: Anzeige der Online-Zeit unter dem Forum
Hallo Welt Beispiel - Daten Variable
Für dieses Beispiel möchten wir eine variable anlegen, in der gespeichert wird, wann ein Mitglied das letzte Mal sein eigenes Profil aufgerufen hat.
Dabei musss für jedes Mitgllied eine eigene Varaiballe gespeichert werden. Gelöst wird das über eine Datenvariable.
Plugin-Entwicklung --> Hallo Welt --> Neue Data Variable:
| Feldname | Wert |
|---|---|
| Name | profileonline |
| Parsing | Plain Text (BBCode und HTML wird hier nicht benötigt) |
| origin_type | user_profile (hier legen wiir fest, dass die Variable einem Benutzerprofil zugeordnet wird.) |
| Type | Chars (theoretisch reicht auch ein Int - es soll ja nur ein Timestamp gespeichert werden) |
| Lesen (alle Leserechte) | Alle (jeder darf den Wert lesen) |
| Schreiben | docreate_plugindefault,dochangeall_plugindefault : Administrator (nur der Admin darf immer alles ändern)docreatemyorigin_plugindefault,dochangemyorigin_plugindefault: Alle (Alle dürfen den Wert der Ihnen zugeordneten Variablen ändern) |
Daten Variable Beschreiben
Jedesmal, wenn ein Mitglied sein Profil besucht, soll der aktuelle Timestamp gespeichert werden.
Dazu nutzen wir die Javascript-Methode setDataVar
Plugin-Dokumentation: setDataVar-Funktion
Plugin API
Damit das klappt, müssen wir ein neue Plugin-Template anlegen, welches immer dann geladen wird, wenn ein Benutzerprofil aufgerufen wird.
Das bisher verwendete Element "Test Oben" wird nicht mehr benötigt und kann vorerst gelöscht werden.
Neues Element erstellen -> Plugin Element
| Feldname | Wert |
|---|---|
| Template | Mitgliederprofil |
| Footer | Inline | Header |
| Template Name | frei wählbar, wir nennen das Element hier Profil Test |
In dem neu erstellten Element könnnen wir nun den Code für die Speicherung der Data-Variablen einfügen:
Im Profil gibt es die Variablen
{{userid}} --> Id des Mitglieds, dessen Profil aufgerufen wird
{{user_id}} --> Id des Mitglieds, welches das Profil aufruft
Ist der Wert beider Variablen identisch, wissen wir, dass ein Mitglied gerade sein eigenes Profil aufruft.
In diesem Fall wollen wir den aktuellen Timestamp in der des Nutzerprofils Data-Variablen abspeichern:
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
{{userid=={user_id}.start}}
<script>
var newval = Date.now(); //erzeugt einen aktuellen Timestamp
var origin_type = 3 //siehe https://www.xobor.de/plugin-doc-api.html#Tipps_und_Tricks_Sonstiges_Target_Types
var user_id = {{userid}}; //id des Mitglieds, dem die Variable zugeordnet wird
//setdataVar-Aufruf:
xobor.plugin("hallowelt").setDataVar("profileonline",origin_type,user_id,newval,function(res){
/*Wert gespeichert, keine Ausgabe notwendig*/
});
</script>
{{userid=={user_id}.end}}
Ruft nun ein Mitglied sein eigenes Profil auf, wird die aktuelle Zeit in der Data-Variablen gespeichert.
Globale Variable Lesen und Anzeigen
Ruft jemand das Profil eines Mitglieds auf möchten wir anzeigen, wann dieses Mitglied zuletzt sein Profil gesehen hat.
Die Abfrage der Variablen geschieht mit der Methode getDataVar()
Plugin-Dokumentation: getDataVar-Funktion
Plugin API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<div id="visitinfo"><!--hier wird später der Wert der Variablen ausgegeben--></div>
<script>
//setdataVar-Aufruf:
xobor.plugin("hallowelt").getDataVar("profileonline",3,{{userid}},function(res){
timeFormat.displayFormat = 'd.m.Y H:i'; // gewünschtes format des datums
lastonline = timeFormat.format(res); //hier erzuegen wir ein schön formatiertes Datum aus unserem Timestamp - details siehe spoiler unten..
$('#visitinfo').html('Letzter Profilaufruf dieses Mitglieds: '+lastonline);
});
</script>
<script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{{userid=={user_id}.start}}
<script>
var newval = Date.now(); //erzeugt einen aktuellen Timestamp
var origin_type = 3 //siehe https://www.xobor.de/plugin-doc-api.html#Tipps_und_Tricks_Sonstiges_Target_Types
var user_id = {{userid}}; //id des Mitglieds, dem die Variable zugeordnet wird
//setdataVar-Aufruf:
xobor.plugin("hallowelt").setDataVar("profileonline",origin_type,user_id,newval,function(res){
/*Wert gespeichert, keine Ausgabe notwendig*/
});
</script>
{{userid=={user_id}.end}}
<div id="visitinfo"><!--hier wird später der Wert der Variablen ausgegeben--></div>
<script>
/**
* man muss ja nicht jedesmal das Rad neu erfinden: Diese Funktion wurde über Google gefunden und formatiert unser Datum im gewünschten Format:
* Return a timestamp with the format "d/m/yy h:MM:ss TT"
* @type {Date}
*/
var timeFormat = {
/**
* Output format.
*
* d - current day
* m - current month
* Y - current Year
*
* H - current hour (24 hour system)
* i - current minute
* s - current second
*/
displayFormat: 'd.m.Y - H:i:s',
/**
* Format given unix-timestamp
*/
format: function(timestamp) {
var d = new Date(timestamp);
var output = this.displayFormat;
output = output.replace(/d/g, this.padZero(d.getDate()))
.replace(/m/g, this.padZero(d.getMonth()+1))
.replace(/Y/g, d.getFullYear())
.replace(/H/g, this.padZero(d.getHours()))
.replace(/i/g, this.padZero(d.getMinutes()))
.replace(/s/g, this.padZero(d.getSeconds()));
return output;
},
/**
* add zero paddings to numbers smaller than 10
*/
padZero: function(number) {
if (number < 10) {
return "0" + number.toString();
}
return number;
}
};
//getdataVar-Aufruf:
xobor.plugin("hallowelt").getDataVar("profileonline",3,{{userid}},function(res){
if(res){
timeFormat.displayFormat = 'd.m.Y H:i'; // gewünschtes format des datums
lastonline = timeFormat.format(res); //hier erzuegen wir ein schön formatiertes Datum aus unserem Timestamp - details siehe spoiler unten..
$('#visitinfo').html('Letzter Profilaufruf dieses Mitglieds: '+lastonline);
}else{$('#visitinfo').html('Dieses Mitglied hat sein Profil noch nicht aufgerufen');}
});
</script>
Abbildung 2: Anzeige der Online-Zeit über dem Profil
Du willst es noch genauer wissen?
Weiter geht's im zweiten Teil des Tutorials: Gruppenrechte
Weiter geht's im zweiten Teil des Tutorials: Gruppenrechte
Hinweis
Login
Activity Feed
Gestern 18:34
m3ontour hat einen neuen Beitrag im Thema Gibt es ein Backup für das Xobor Wiki geschrieben.
Hallo Ingmar,hast du die Daten bekommen?
Gestern 16:44
Mike48 und Gemshorn haben 2 neue Beiträge im Thema Artefakte in hochgeladenen Bildern geschrieben.
Ich kann da keinen Unterschied feststellen. Edit:Ich habe doch einen Unteschied gefunden. Es sind unterschiedliche Formate. Eins ist PNG das ander JPG, Beide sind 163x96 und sehen gleich aus.
Hallo,ich habe heute festgestellt, dass Bilder, die per STRG + V in einen Beitrag hochgeladen wurden, sauber dort ankommen. Qualität astrein!Lade ich dasselbe Bild als Datei von meinem PC aus hoch, ist das Ergebnis nach dem Upload minderwertig.Warum?
Keine Zahl in den Einstellungen ist negativ. Nach Neuinstallation berichten User weiterhin von dem Problem. Schade, wär ne einfache Lösung gewesen.
%usernames% hat sich bedankt!
Hallo, wir haben das „Briefumschlagplugin“ installiert. Ich habe kürzlich das Update durchgeführt. Nun melden User folgendes: https://ere.xobor.de/t18127f24752-PN-ist...html#msg1035036Viele Grüße
Zitat von spotter46 im Beitrag #3Mal z.B. wurde ein einzelnes Motorrad abgebildet und es mussten alle Felder mit Motorrad abgehakt werden. Das kann bekanntlich eher mal zu Fehlern führen, aber wenn in einem anderen Fall in Collagenform mehrere Einzelbildchen gezeigt werden, dann kann man mir schon z...
%usernames% hat sich bedankt!
18.01.2025 17:46
%usernames% hat sich bedankt!
18.01.2025 16:40
ThomasB., Mike48 und m.schenker haben 3 neue Beiträge im Thema Keine Email bei "Passwort vergessen" über Freenet?! geschrieben.
Ja, hat sie. Auch dort nichts angekommen.
18.01.2025 13:07
Ingmar hat einen neuen Beitrag im Thema webp Grafik wird fehlerhaft hochgeladen geschrieben.
Kann ich reproduzieren. Seltsam, letzte Woche habe ich noch webp Grafiken hochgeladen.Danke fürs melden.
webk Grafiken werden fehlerhaft bzw. gar nicht hochgeladenfolgendes erscheint:[[File:Ashampoo_Snap_2025.01.18_12h26m05s_005_.jpg|none|auto]]und--------------------------------------------[[File:Ashampoo_Snap_2025.01.18_12h09m11s_003_.jpg|none|auto]]
18.01.2025 00:26
spotter46 und focus haben 2 neue Beiträge im Thema Frage zur Statistik und Auswertung geschrieben.
Zitat von focus im Beitrag #8Ich habe den Basis Tarif, allerdings kann ich die Mitgliederliste nicht als CSV Datei expotieren !!??Ja, Du hast Recht, wie ich nach einem Test in einem Forum mit Basistarif leider mit Verspätung festgestellt habe.Man mag es bedauern, aber es ist halt so, dass Miranus-X...
%usernames% hat sich bedankt!
17.01.2025 22:05
Ingmar, spotter46 und Mike48 haben 7 neue Beiträge im Thema Captcha - Akustische Lösung geschrieben.
Zitat von spotter46 im Beitrag #5Warum nutzt ihr nicht euer eigenes Xobor-Captcha ? Ist das so sehr unsicherer ?Es hat durchaus ein paar Nachteile. Z.b ist es eben nicht barrierefrei. Außerdem kann es zu Problemen kommen, wenn viele Mitglieder über die gleiche IP online gehen.Wir haben hier beim Log...
%usernames% hat sich bedankt!
Hallo Markus,habe auch immer wieder Spam Mails in meinem Ordner.Denke, daß hat etwas mit dem Impressum des Forums zu tun.Da muß ja leider die Mailaddy angegeben werden.Manche schauen dort halt einfach nach und senden dir dann ihren Müll.Da kann man wohl leider nichts dran ändern.
%usernames% hat sich bedankt!
Nachdem ich gestern etwa 3/4-Stunde vergeblich versucht habe, mich hier einzuloggen und zunächst die Fehlermeldung kam, Benutzername und/oder Passwort wären nicht korrekt, musste ich beim erneuten Versuch das Captcha lösen.Ich bin kein Anfänger und Captchas gibt's ja nicht nur hier im Supportforum, ...
%usernames% hat sich bedankt!
%usernames% haben sich bedankt!
Habe auch gerade die fixierten breadcrumbs ausprobiert und muss feststellen, dass die Einstellung nur in der Threadansicht wirkt. Das ist ganz praktisch, um so den Threadtitel immer im Blick zu haben. Ich könnte mir gut vorstellen, dass eine Fixierung auch in der Forumansicht hilfreich wäre, um das ...
17.01.2025 10:42
spotter46 und Peltzer haben 4 neue Beiträge im Thema Link in den Beiträgen geschrieben.
Zitat von Peltzer im Beitrag #8Booohhhhh, ich ziehe alles zurück, sorry.Ist da. Ich konnte mit dem Symbol überhaupt nichts anfangen. GrußAxelKein Problem.Daher ist der intensive "Genuss" vom Xobor-Wiki und zum ebenso intensiven und gefahrlosen testen die Anlage eines eigenen Testforums angeraten.
Update: Die fixierten Breadcrumbs scheinen das wichtigere Feature zu sein - und das lässt sich ja im Adminbereich per Schalter aktivieren. Das fixierte Menü habe ich nun wieder deaktiviert. Vielleicht die einfachste Lösung.Danke fürs Mitlesen.
V6.Meine User wünschen sich einerseits ein fixiertes Menü und andererseits auch fixierte Breadcrumbs.Aktiviere ich beides, überlagern sich Menü und Breadcrumbs aber dergestalt, dass die Navigationsbuttons ÜBER den Breadcrumbs zu liegen kommen, sodass man letztere nicht mehr anklicken kann. Könnt ihr...
16.01.2025 15:51
m3ontour und 3 weitere haben 4 neue Beiträge im Thema Gibt es ein Backup für das Xobor Wiki geschrieben.
Hallo Ingmar,ich habe dir die Daten als Mail auf Xobor Supportforum <news@hpm-support.de> gesendet.Vielen Dank vorab
%usernames% hat sich bedankt!
%usernames% hat sich bedankt!
%usernames% haben sich bedankt!
Wer ist Online?
0 Mitglieder und 47 Gäste sind OnlineBesucher Statistiken
Statistiken
| Themen | 41767 |
| Beiträge | 305690 |
| Mitglieder | 12.466 |
Forum empfehlen