Praxisbeispiel: Plugin "Close Old Threads"

Plugin-Entwicklung



Im folgenden Beispiel wird die Entwicklung des Plugins "Close Old Threads" beschrieben.

0) Anforderungen


Oft passiert es, dass gerade neue Mitglieder ein altes Thmea über die Suchfunktion auffinden und dort posten, obwohl bereits eine lange Zeit kein Beitrag mehr in diesemThema geschrieben wurde. Für den Administrator ist es aber unzumutbar, ständig das Forum zu kontrollieren, um alte Beiträge zu schließen. Das neue Plugin soll dem Admin diese Arbeit abnehmen und beim Aufruf eines Themas automatisch prüfen, ob ein Thema zu alt ist oder nicht.
Für Themen die ein bestimmtes Alter überschritten haben, kann ein Warnhinweis angegeben werden, für noch ältere Themen werden komplett geschlossen.

Der Administrator soll festlegen können, nach wie vielen Tagen eine Warnung bzw. eine Schließung erfolgt. Außerdem solle es möglich sein Gruppen zu definieren, die von der Schließung nicht betroffen sind.




1) Neues Plugin erstellen



In der Foren-Administration unter Plugins->Plugin Entwicklung können neue Plugins erstellt werden.

Plugin ID & Plugin Name
Die ersten beiden Werte, die bei der Erstellung eines Plugins angegeben werden müssen sind die Plugin ID und der Plugin Name. Die ID ist der interne Name des Plugins. Er darf keine Sonderzeichen enthalten. Der Pugin Name ist der Name des Plugins, den später der Endbenutzer zu sehen bekommt.


Plugin ID: threadautoclose
Plugin Name: Close Old Threads




2) Elemente des Plugins definieren



Ein Plugin besteht aus folgenden Elementen:

  • Content-Element
    Template-Elemente, Javascript oder HTML-Dateien
  • Config-Variablen
    Einstellungen für das Plugin
  • Daten Variablen
    In diesen Variablen werden Werte und Daten gespeichert, die das Plugin benötigt. Datenvaraiblen werden immer einer Quelle (Origin) zugeordnet. Wird eine Variable z.B. dem Benutzerprofil zugeordnet, stehen die gespeicherten Werte später immer zur Verfügung, wenn ein benutzerprofil geöffnet ist.
  • Globale Variablen
    Funktionieren genau wie Daten-Variablen, allerdings stehen die hier gespeicherten Werte später auf allen Seiten des Forums zur Verfügung. Dies kann die Performanz negativ beeinflusssen und sollte daher vorsichtig eingesetzt werden.



Für das Close Old Threads Plugin benötigen wir keine Variablen, die Daten speichern. Allerdings möchten wir dem Administartor einige Einstellungen ermöglichen, daher legen wir drei Config-Variablen an:

Variablen
1) maxdays_messageage_warning
Nach X Tagen soll eine Warnung angezeigt werden, dass das Thema schon alt ist.
Die Variable ist von Typ int und bekommt den Standardwert 180

2) maxdays_messageage_close
Nach X Tagen soll das Thema ganz geschlossen werden.
Die Variable ist von Typ int und bekommt den Standardwert 360

3) plugin_exceptions
Hier können Gruppen angegeben werden, welche auch nach dem erreichen von maxdays_messageage_close noch antworten können.
Die Variable ist vom Typ grouprights und bekommt den Standardwert administrator

Templates
Das Plugin soll später an zunächst 2 Stellen im Forum aktiv werden: Einmal beim Schreiben eines Beitrags, und einmal in der Themenansicht.

Wir benötigen daher 2 neue Template-Elemente:

Plugin Template Element "New Message"


Wir ordnen unser neues Element dem Foren-Template "Neuen Beitrag Schreiben" zu und erreichen damit, dass der Code des Templates immer ausgeführt wird, wenn das Template "Neuen Beitrag Schreiben" aufgerufen wird.


Desweiteren können wir festlegen, wann genau das Plugin Template ausgeführt werden soll:


Header -> das Plugin-Template wird direkt VOR dem Foren-Template ausgeführt.
Footer -> das Plugin-Template wird direkt NACH dem Foren-Template ausgeführt.
Inline-Element -> Die ermöglich die Ausführung der Plugin-Codes innerhalbt des Foren-Templates. Hierzu gibt es in den Foren-Templates Markierungen. Im "Neuen Beitrag Schreiben"-Template gibt es eine solche Markierung z.B. innerhalb des "Beitrag Schreiben" Formulars. Zu den Markierungen in den Template -Elementen wird es in Kürze noch ein eigenes Tutorial geben.


Unsere Einstellungen für das Element "New Message" lauten also:
Template: Neuen Beitrag Schreiben
Inline-Element: "new_message_in_form" (Name der Markierung im Foren Template)
Template Name: new_message

Analog dazu wird auch das Template "topic" angelegt:
Template: Themen Ansicht
Header: JA - das Plugin-Template soll vor dem Laden der Beiträge angezeigt werden.
Template Name: topic





3) Plugin Elemente schreiben


Wir haben nun alle Elemente des Plugins definiert und den jeweiligen Foren-Templates zugeordnet. Im nächsten Schritt schreiben wir nun den Code des Plugins

Plugin-Templates funktionieren fast genau wie normale Foren-Templates. Es stehen alle Foren-Variablen zur Verfügung, die auch im verknüpften Template-Element verwencet werden. Außerdem stehen die Variablen des Plugins zur Verfügung.

Auf den Wert der Variablen maxdays_messageage_warningzum Beispiel kann im Plugin Template mit {{plugin_threadautoclose_config_maxdays_messageage_warning}} zugegriffen werden.
Für Rechtevariablen erzeugt das System automatisch eine zusätzliche boolean-Variable. D.h während die Variable {{plugin_threadautoclose_config_plugin_exceptions}} die Gruppen-Ids der Gruppen enthält, die von der Themenschließung nicht betroffen sind, enthält {{plugin_threadautoclose_config_plugin_exceptions_boolean}} einen true/false Wert, der für den aktuellen Benutzer angepasst wird.


Das Element new_message setzt folgendes um:

Beim laden von "Neuen Beitrag Schreiben" prüfen wir ob

1) Das maximale Themenalter erreicht wurde
1a) Falls ja: Prüfen Ob das Mitglied in der "Ausnahmen"-Gruppe ist.
1aa) Falls ja: Warnhinweis anzeigen, dass das Thema eigentlich geschlossen wäre
1ab) Falls nein: Thema als geschlossen anzeigen, Laden des "Beitrag schreiben" Templates unterbinden

2) Das Themenalter für eine Warnung reicht:
2a) Falls ja: Warnung anzeigen

Das könnte dann z.B. so aussehen:

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
 
<!--{{reply==true.start}} = Nur laden, wenn geantwortet wird:-->
{{reply==true.start}}
 
<!--Berechnung der Tage seit der letzten Antwort-->
{{secs_since_message.startint}}{{server_time}}-{{thread_lastmessage_ts}}{{secs_since_message.end}}
{{days_inactive.startint}}{{secs_since_message}}/60/60/24{{days_inactive.end}}
 
{{limitreached.start}}0{{limitreached.end}}
 
<!--Thread ist älter als in maxdays_messageage_close definiert-->
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.start}}

 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.start}}
<!--Thread ist älter als in maxdays_messageage_close definiert - aber der USer ist in einer ausgenommenen Gruppe-->
{{limitreached.start}}1{{limitreached.end}}
<div class="threadinactive">In diesem Thema wurden seit mehr als {{plugin_threadautoclose_config_maxdays_messageage_close}} Tagen kein Beitrag verfasst. <br/>Bitte überlegen Sie vor dem posten ob es nicht sinnvoller ist, ein neues Thema zu eröffnen</div>
 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.else}}
<!--Thread ist älter als in maxdays_messageage_close definiert - Thema wird als geschlossen angezeigt-->
<div class="threadinactive_hardlimit" style="text-align:center;">
Dieses Thema wurde aufgrund von Inaktivität geschlossen. <br/>Bitte eröffnen Sie bei Bedarf ein neues Thema.<br/>
<a href="{{reply_message_link}}" class="button button1">zurück zum Beitrag</a>
</div>

<!--Diese Funktionen veerhindern, dass weitere Templates geladen werden-->
{{template_stoploading(new_message)}}
{{template_stoploading(quote_html)}}
 
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.end}}
 
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.end}}
 
<!--Thread ist älter als in maxdays_messageage_warning definiert - Warnhinweis anzeigen-->
{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_warning.start}}{{days_inactive<plugin_threadautoclose_config_maxdays_messageage_close.start}}
{{limitreached.start}}1{{limitreached.end}}
<div class="threadinactive">Bitte beachten Sie, dass in diesem Thema schon länger kein Beitrag mehr verfasst wurde.<br/>Überlegen Sie vor dem posten ob es nicht sinnvoller ist, ein neues Thema zu eröffnen.</div>
{{days_inactive<plugin_threadautoclose_config_maxdays_messageage_close.end}}{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_warning.end}}
 

<!--Hier wird der eingefügte Code per Javascript auf der Seite positioniert. Je nach Template wird er an eine unterschiedliche Position geschoben-->
{{limitreached==true.start}}
 
<script>
$(document).ready(function(){
{{template==1.start}}var $infotexttarget = $('#previewbutton').closest('table');{{template==1.end}}
{{template==111.start}}var $infotexttarget = $('#previewbutton').closest('table');{{template==111.end}}
{{template==110.start}}var $infotexttarget = $(".submit-buttons");{{template==110.end}}
{{template==144.start}}var $infotexttarget = $("#newmsg");{{template==144.end}}
$('.threadinactive').insertBefore($infotexttarget);
});</script>
{{limitreached==true.end}}
{{reply==true.end}}
 



Das Element "topic" wird auf der Themen Ansicht geladen. Für die erste Version des Plugins beschränken wir uns darauf, die Schnellantwort auszublenden, wenn das Limit überschritten wurde (da Mitglieder ja sonst auf diesem Wege dennoch Beiträge schreiben könnten).


{{secs_since_message.startint}}{{server_time}}-{{thread_lastmessage_ts}}{{secs_since_message.end}}
{{days_inactive.startint}}{{secs_since_message}}/60/60/24{{days_inactive.end}}

{{limitreached.start}}0{{limitreached.end}}

{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.start}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.start}}
{{limitreached.start}}1{{limitreached.end}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.else}}
{{reply_quick.start}}0{{reply_quick.end}}
{{plugin_threadautoclose_config_plugin_exceptions_boolean==true.end}}

{{days_inactive>plugin_threadautoclose_config_maxdays_messageage_close.end}}




4) Testen



Wenn alles klappt, sollten nun beim beantworten alter Themen keine Antwort mehr möglich sein.




5) Veröffentlichen



An dieser Stelle ist die erste Version des Plugins fertig für die Veröffentlichung im Plugin-Store. Dazu geben wir in den Plugin-Einstellungen die gewünschte Versionsnummer an (Falls bereits eine Version des Plugins veröffentlicht wurde muss die versionsnummer höher sein als zuvor!) und klicken auf "In Plugin Store veröffentlichen. Da wir bei den Plugin-Einstellungen festgelegt haben, dass das Plugin sichtbar für alle ist (Public Store) erscheint das Plugin nun im öffentlichen Plugin Store, sobald ein Xobor Mitarbeiter den Code überprüft und für gut befunden hat.

Ist das Plugin erst einmal im Plugin Store, kann es von allen Xobor Foren mit einem Klick installiert und verwendet werden.

6) Erweitern



Die Arbeit hört hier natürlich nicht auf. Man könnte noch Variablen hinzufügen, die dem Admin erlauben, selbst die angezeigten Texte festzulegen. Oder man fügt bei der Themen-Ansicht gleich das "Thema geschlossen"-Icon ein wenn das Antworten nicht gestattet ist.

Nachdem ein Plugin verändert wurde, muss eine neue Versionsnummer angegeben werden, bevor es im Plugin Store veröffentlicht werden kann. Ist eine neue Version verfügbar, können alle Foren das Update mit einem Klick installieren.


Login
Letzte Aktionen im Forum
forum_message forum_message
Habe alles so eingestellt wie auf dem abbild, aber sehe noch immer nichts, um bilder hochzuladen.Hierbei handelt es sich um das forum : strandgutforum.xobor.deForen-Nummer 838477
rating rating
Gabriella hat sich bedankt!
Beitrag: Bildergalerie
%usernames% hat sich bedankt!
rating rating
%usernames% haben sich bedankt!
forum_message forum_message
Gabriella hat einen neuen Beitrag im Thema Bild im Beitrag geschrieben.
Hallo Bocki,wenn Du das Bild hochgeladen hast, musst es auch Einfügen, einfach auf den Button klicken. Da ist auch noch ein Auswahlfenster mit 3 Kriterien Auto, Vollbild, oder Werte angeben. Nur dann wird das Bild im Beitrag gezeigt, ansonsten steht da angehängt von sowieso.
forum_message forum_message
Hallo @Lindavienna Sorry für die späte Rückmeldung. Es gab da einen kleinen Fehler in der Funktion "Paypal Express Checkout", weshalb die Bestellung dem Forum nicht korrekt zugeordnet wurde.Du hast das Geld daher am 18.01 wieder zurückbekommen.Wenn weiterhin Interesse am Tarif besteht bitte einfach ...
forum_message forum_message
Ingmar hat 3 neue Beiträge im Thema Bildergalerie geschrieben.
Da Mike dir das so schön beschrieben hat würde ich vorschlagen wir schließen das hier und machen im anderen Thema weiter:Eigene Bildergalerie erstellen funktioniert nicht???
rating rating
Ingmar hat sich bedankt!
Beitrag: Newsletter
%usernames% hat sich bedankt!
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Havaneserherzen Admin hat einen neuen Beitrag im Thema Newsletter geschrieben.
Danke @Ingmar heute kam wirklich nur noch 1 Mail
rating rating
Havaneserherzen Admin hat sich bedankt!
Beitrag: Newsletter
%usernames% hat sich bedankt!
forum_message forum_message
Daytona hat einen neuen Beitrag im Thema Suche Funktioniert nicht geschrieben.
@Ingmar ist der Fehler nachvollziehbar?
forum_topic forum_topic
Bocki hat das Thema Bild im Beitrag erstellt
Hallo liebe Mitglieder,ich habe zum ersten Mal ein Forum und finde mich auch inzwischen recht gut zurecht.Meine Frage:In einem neuen Beitrag füge ich über Datei anhängen ein Bild hinzu.Das wird unter dem Beitrag auch super angezeigt mit einem Link darunter.Um das Bild zu öffnen muss ich auf den Link...
forum_message forum_message
nobody hat einen neuen Beitrag im Thema Editieren einiger Beiträge nicht mehr möglich geschrieben.
@IngmarGilt die Behebung nur fürs obige Forum?In meinen Foren tritt nämlich derselbe Fehler auch auf.
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Das zweite Album wurde mit Coverbild erstellt. Aber innen im Album erscheint kein Button mehr.
forum_message forum_message
Wow, super Lösung!Habe schon etwas mit "onclick" hinbekommen, aber da hätte das Template verändert werden müssen! Bei mir funktioniert der CSS-Eintrag im Gaja nur mit !important (Zeile 2).Es fehlen allerdings die Untermenüs! Mit "padding" währe das nicht so elegant, weil die Untermenüs sich der Brei...
forum_topic forum_topic
Lindavienna hat das Thema Bildergalerie erstellt
Wieso funktioniert die Bildergalerie in strandgutforum.xobor.de838477 nicht?
rating rating
%usernames% hat sich bedankt!
forum_message forum_message
Ok, Danke Ingmar für die Antwort.Es wäre jedenfalls toll wenn eine PN bzw. eine Benachrichtigung an alle Mitglieder geht wenn ein neuer Blogeintrag geschrieben worden ist, unabhängig davon ob es jetzt ein Eintrag im userblog oder im Forumsblog ist.Vielleicht lässt sich das ja irgendwann mal realisi...
rating rating
%usernames% hat sich bedankt!
rating rating
Roger34385 und Gabriella haben sich bedankt!
Beitrag: Newsletter
%usernames% haben sich bedankt!
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Editieren einiger Beiträge nicht mehr möglich geschrieben.
Danke für die Meldung, wird morgen behoben.
forum_message forum_message
Ingmar hat einen neuen Beitrag im Thema Anmeldung und Themen schreiben- Fehlermeldung geschrieben.
Uns sind da bisher keine Probleme bekannt.Tritt das denn auch auf, wenn du das Forum testweise ohne Plugins aufrufst?-edit- Und was steht in der Adresszeile des Browsers, wenn die Fehlermeldung erscheint?
rating rating
Gabriella und Havaneserliebe haben sich bedankt!
Beitrag: Rahmen Codes fürs Forum
%usernames% haben sich bedankt!
forum_message forum_message
Gabriella und Ingmar haben 2 neue Beiträge im Thema Verwarnungssystem 2020 geschrieben.
Danke Ingmar,ich habe da natürlich als Admin geschaut und vorhin mit dem Testuser eben auch der ist Mod, also kann ich es in dem Fall nicht sehen. Danke wieder etwas gelernt.
%usernames% hat sich bedankt!
forum_message forum_message
xnapqueen, Daytona und Ingmar haben 3 neue Beiträge im Thema Suche Funktioniert nicht geschrieben.
Hallo Wir haben anscheinend genau das gleiche Problem. Die geschriebenen Beiträge kommen nicht mit dem übereinander was bei 'Beiträge von User XX suchen' zu finden ist auf dem Profil. Da taucht nur die Hälfte auf, wenn überhaupt. Und wenn man runter scrollt auf der Seite, springt die Funktion schnel...
forum_topic forum_topic
Hallo ihr lieben, gerade ist bei uns im Forum aufgetreten, der nicht nur die Member betrifft, sondern auch uns Admins, bzw. mich. Wenn die Member sich anmelden oder ich mich abmelde und wieder anmelde kommt folgende Fehlermeldung:Es ist ein Fehler aufgetreten!Die Funktion konnte nicht aufgerufen wer...
rsummary rsummary
Gabriella und Ingmar haben 2 Beiträge bewertet (Details)
%usernames% haben sich bedankt!
rsummary rsummary
Ingmar und River haben 2 Beiträge bewertet (Details)
%usernames% hat sich bedankt!
rsummary rsummary
Scannerxy, Roger34385 und Gabriella haben 2 Beiträge bewertet (Details)
%usernames% haben sich bedankt!

Wer ist Online?
5 Mitglieder und 41 Gäste sind Online
Statistiken
46 Aktive User
5 Mitglieder und 41 Gäste sind Online:
Lindavienna, Lady of the light, Ingmar, Gabriella, nobody


Besucherrekord
1274 Benutzer gleichzeitig online (11.10.2019 18:19)

Besucherzähler
Heute waren 1838 Gäste und 31 Mitglieder, gestern 3344 Gäste und 54 Mitglieder online.