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
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



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
 

{{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
 

{{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
 

{{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}}
 
 





screenshot
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



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
 
{{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()




1
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
 

{{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>
 

 





screenshot
Abbildung 2: Anzeige der Online-Zeit über dem Profil



Du willst es noch genauer wissen?
Weiter geht's im zweiten Teil des Tutorials: Gruppenrechte
Hinweis


Login
Activity Feed
rating rating
nighti hat sich bedankt!
Beitrag: Kapazitätserweiterung - Neue Server für Xobor
%usernames% hat sich bedankt!
forum_topic forum_topic
balea hat das Thema Foren-Chat erstellt
Seid heute geht der Foren-Chat bei uns nicht. Er geht zwar auf, aber es erscheinen keine Namen. Könnte da mal jemand nach schauen?
forum_message forum_message
Jack Sallow, Ingmar und Johannes haben 5 neue Beiträge im Thema Forum Übersicht völlig zerrissen geschrieben.
Hallo oder schon guten Morgen? Tatsächlich habe ich.. nach stundenlanger Suche und Recherche den Fehler gefunden, der bei uns zuvor nie einen Fehler ausgelöst hatte und dafür gesorgt hat, dass der Template-Compiler abgestürzt ist. Das habe ich korrigiert und jetzt läuft alles wieder einwandfrei. Man...
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
markusp hat einen neuen Beitrag im Thema Ziellink in der Navigation ändern geht nicht geschrieben.
@Ingmar also ich kann jetzt gerade in Layout - Navigation das "r" wegmachen, gut.Aber es kommt wieder 8-)Layout - Navigation - ein Board auswählen, hier bei mir im Loewenfrankfurt-playground.de das "Mod-Board" das "für alle sichtbar" ist und das soll geändert werden. Im Adminweitere Einstellungen - ...
forum_message forum_message
l2otbart_57 und JanB haben 2 neue Beiträge im Thema Nach Server-Umzug funzt die Suche nicht geschrieben.
Zitat von JanB im Beitrag #2.... Alles wieder OK. 👍🏻 nein leider nichtim V4 haben die Folgeseiten der Suche eine komische URL: (&page=)-Parameter doppelt, zb für Seite 61 ..../search.php?q=test ..... &orderdirection=DESC&perpage=50&page=&page=6 
rating rating
Johannes hat sich bedankt!
Beitrag: Nach Server-Umzug funzt die Suche nicht
%usernames% hat sich bedankt!
forum_message forum_message
Johannes und 6 weitere haben 13 neue Beiträge im Thema Forum existiert nicht mehr????? geschrieben.
es geht wohl um https://colorful-river.xobor.de/
rating rating
Janine Fuchs hat sich bedankt!
Beitrag: Forum existiert nicht mehr?????
%usernames% hat sich bedankt!
rating rating
BeNew und 3 weitere haben sich bedankt!
Beitrag: Forum existiert nicht mehr?????
%usernames% haben sich bedankt!
forum_topic forum_topic
JanB hat das Thema Nach Server-Umzug funzt die Suche nicht erstellt
Vielleicht besser getrennt als 'Bug', dass unsere Suche nach dem Umzug vorhin nicht mehr funktioniert,auch wenns ein Anschluss-Thema ist zu "Forum existiert nicht mehr" und ähnlich ist zum Thema "Suche (funktioniert nicht mehr)".
rating rating
ADullham hat sich bedankt!
Beitrag: Kapazitätserweiterung - Neue Server für Xobor
%usernames% hat sich bedankt!
forum_topic forum_topic
Nicole Gerling hat das Thema Forum existiert nicht mehr????? erstellt
Hallo in die Runde,ich war heute morgen ganz normal in meinem Forum und jetzt ist es weg. Es ist ein Standart Forum, kostenlos. Wir sind nur zu zweit. Jetzt ist es weg. Kann mir einer erklären warum???Grüße Nicole/Schnubbel
forum_message forum_message
Guten Morgen,wir haben eben dieses Problem bei uns - seit 5min.Liebste Grüße!851184 | Gaia
rating rating
Ingmar hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Mir wurde bestätigt, daß jetzt alles wieder prima funktioniert. Nochmal recht herzlichen Dank!Kordula
rating rating
zickzack und 1 weitere haben sich bedankt!
Beitrag: Ziellink in der Navigation ändern geht nicht
%usernames% haben sich bedankt!
rating rating
Charles und 2 weitere haben sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% haben sich bedankt!
rating rating
Charles hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
rating rating
Mike48 hat sich bedankt!
Beitrag: Admin Ansicht ist in der Free Version anders?
%usernames% hat sich bedankt!
rating rating
Knox hat sich bedankt!
Beitrag: Admin Ansicht ist in der Free Version anders?
%usernames% hat sich bedankt!
forum_message forum_message
Knox und 1 weitere haben 2 neue Beiträge im Thema Admin Ansicht ist in der Free Version anders? geschrieben.
So einfach ist die Lösung. Vielen Dank. Das hab ich wirklich glatt übersehen.
forum_topic forum_topic
Knox hat das Thema Admin Ansicht ist in der Free Version anders? erstellt
Hey zusammen,ich hab jetzt nicht explizit das selbe gefunden wie ich hier zeigen kann - aber vielleicht übersehe ich etwas und jemand kann mir helfen oder erklären was der Unterschied ist.Ich bin derzeit am rumcoden und baue neue Features fürs Hauptforum. Die teste ich natürlich vorher in einem kost...
rating rating
spotter46 hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
forum_message forum_message
Kipper-Spedition und 1 weitere haben 2 neue Beiträge im Thema Unsere Top 500 Xobor-Foren geschrieben.
Mal ehrlich, schaut ihr jeden Tag, wie hoch ihr im Ranking beim "XOBOR Top 500 seit?Spaß beiseite, aber auf die Größe kommt es ja nun wirklich nicht an...Armer @Johannes
forum_message forum_message
Kipper-Spedition und 3 weitere haben 6 neue Beiträge im Thema Ziellink in der Navigation ändern geht nicht geschrieben.
Aktuell kann ich keine Benutzergruppe in der Navigation ändern!Der Haken wird gelöscht - speichern - der Haken ist wieder drin!Wo ist der Haken liebes XOBOR-Team? Bzw. warum ist der Haken wieder da?
rating rating
markusp hat sich bedankt!
Beitrag: Ziellink in der Navigation ändern geht nicht
%usernames% hat sich bedankt!
rating rating
zickzack hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
rating rating
spotter46 und 2 weitere haben sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% haben sich bedankt!
rating rating
Lady of the light hat sich bedankt!
Beitrag: Unsere Top 500 Xobor-Foren
%usernames% hat sich bedankt!
forum_message forum_message
Mike48 und 2 weitere haben 3 neue Beiträge im Thema Unsere Top 500 Xobor-Foren geschrieben.
Zitat von Johannes im Beitrag #36Heute wird zum Beispiel ein weiterer alter Server migriert, damit wir in den kommenden Wochen und Monaten nach vorne schauen können und viele neue Interessante Dinge bei Xobor vorstellen können.Dann werden wir mal fest die Daumen drücken dass es nicht so holprig wird...
forum_message forum_message
Jaden hat einen neuen Beitrag im Thema Portalboxen bearbeiten nicht möglich geschrieben.
Hallo Ingmar.Heute morgen hat es endlich funktioniert.
rating rating
%usernames% hat sich bedankt!
rsummary rsummary
Janine Fuchs und 4 weitere haben 2 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Ingmar und 1 weitere haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
zickzack und 5 weitere haben 5 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
markusp und 4 weitere haben 4 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
Wer ist Online?
5 Mitglieder und 64 Gäste sind Online
Besucher Statistiken
69 Aktive User
5 Mitglieder und 64 Gäste sind Online:
nighti, Johannes, Katja Diehl, Ingmar, markusp


Besucherrekord
2542 Benutzer gleichzeitig online (25.03.2026 01:44)

Besucherzähler
Heute waren 3537 Gäste und 26 Mitglieder, gestern 6019 Gäste und 44 Mitglieder online.

Statistiken
Themen 42386
Beiträge 311359
Mitglieder 12.664
Forum empfehlen