Im folgenden Beispiel wird die Entwicklung des Plugins "Close Old Threads" beschrieben.
0) Anforderungen
Oft passiert es, dass gerade neue Mitglieder ein altes Thema über die Suchfunktion auffinden und dort posten, obwohl bereits eine lange Zeit kein Beitrag mehr in diesem Thema 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, 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. Datenvariablen 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
<!--{{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)}}
<!--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}}
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).
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.
Hallo allerseits!Ich habe mir ein neues Forum mit dem Business Template (v4) zugelegt, in dem sowohl auf Englisch als auch auf Persisch geschrieben werden soll. Ich habe eine Kategorie angelegt, wo in den dort angelegten Foren und den verschiedenen Threads nur auf Persisch geschrieben wird bzw. werd...
Zitat von Mike48 im Beitrag #9Zitat von l2otbart_57 im Beitrag #6um die Bibliotheken mache ich mi gar keine Gedanken.Musst du aber wenn du die Seite ohne Kopf- Fußzeile einrichtest. Vielleicht reicht die Fußzeile.Ich habe meine leere Seite z. B. als game.js gespeichert. Die enthält dann meine Funkti...
Diese Fehlermeldung ist schon 3 Monate her.Ist jetzt auch nicht sooooo wichtig,aber es ist ein Fehler.Die Bilder fliegen immer noch von einer Seite zur anderen,ohne das ich sie mir ansehen kann.Gut zu sehen in meinem Plugin "Kalenderfarben ändern".GrußOlaf
Die Konfigurations Einstellungen in der neuen Admin sehen furschtbar aus. Die einzelnen Einstellungen in einem Plugin sind nicht durch eine Linie getrennt. Sehr unübersichtlich.In Plugin Home sind so viele Plugins gelistet dass man Mühe hat, an die Liste der installierten zu kommen. Die Seite Plugin...
Ich glaube die einstellung greift nur, wenn das Ziel mehr als 0 euro sind.Du kannst nebenan einstellungen, welche gruppen die box sehen sollen (oder auch nicht sehen sollen)
Hi,bei uns (untis-anwender.at) wird die Spendenbox derzeit angezeigt, obwohl unser Spendenziel 0 € ist und das Konto auch auf 0 € ist. Die Einstellungen sind:[[File:Forenkonto Null.png|none|auto]]Eigentlich möchte ich die Box erst wieder im Herbst anzeigen (unsere Rechnung kommt im Januar). Was tun?...
Ich weiß nicht genau ob es ein Bug ist oder ob es mit Absicht so gewollt ist.Wenn ich im Plugin eine "eigene Seite" anlege und dort eine Globale Variable oder eine Konfigurationsvariable erstelle,dann kann ich sie weder beschreiben noch lesen.Aber andersherum frage ich mich dann,wieso man die Variab...
Zitat von spotter46 im Beitrag #11Da zitieren aktuell nur sporadisch funktioniertDanke für die Erinnerung. Das sollte jetzt wieder besser klappen.Ich hatte das heutige Update hier im Forum noch nicht eingespielt.
Gestern 21:471743450448
Marlies Stockmann und 2 weitere haben 4 neue Beiträge im Thema Zeitumstellung geschrieben.
Moin,ich benutze ein Premium Email Postfach und bekomme da regelmäßig Spam geschickt.Gibt es ein konfigurierbare Spam Filter? Oder wie wird da schon gefiltert?Hier ein Beispiel mit Spam Level 2 welche einfach durch gelassen wird:1234567 X-Virus-Scanned: Debian amavisd-new at het30.serv.miranus.comX-...
Forum empfehlen