In diesem Tutorial beschreiben wir den Weg der Plugin-Erstellung anhand eines Beispiels in verständlichen Worten und mit vielen ergänzenden Informationen. Zur Startseite des TutorialsAllgemeiner 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
Konfigurationsvariablen für das Plugin Hallo Welt
Beschreibung
In diesem Tutorial wollen wir dem Admin die Möglichkeit geben, die Schriftgröße sowie die Ausrichtung des angezeigten Textes zu verändern.
Wie kann das funktionieren?
Über Konfigurationsvariablen, die vom Admin eingestellt werden und danach vom Plugin ausgelesen werden können.
Bedarfsanalyse
Für die Planung unseres Plugins müssen wir zunächst überlegen, welche Plugin-Elemente wir benötigen.
- Template-Elemente
- an welchen Stellen im Forum soll das Plugin später ausgeführt werden? - Konfigurations-Variablen
- welche Einstellungen soll der Admin später vornehmen können. - Daten/Globale Variablen
- welche Daten müsssen vom Plugin gespeichert werden
Plugin Elemente erstellen
Template-Elemente - für diesen Teil des Tutorials benötigen wir keine zusätzlichen Template-Elemente
Konfigurations Variablenwir benötigen 2 Einstellmöglichkeiten: Die
Position und die
Schriftgröße des Textes
Wir wählen also in der Plugin-Entwicklung zunächst
neue Config-Variable und legen dort eine Variable mit folgenden Werten an:
Name: hallowelt_ausrichtung
Gewichtung: 1
Titel: Ausrichtung des Willlkommens-Textes
Beschreibung: Bitte wählen Sie hier die Ausrichtung des Textes (left, right oder center)
Hidden: Nein
Type: Chars
Chars: center //standardwert
Tipp: Um Probleme mit Variablen anderer Plugins zu vermeiden sollte ein eindeutiger Name vergeben werden. In diesem Fall wird einfach die PluginID und ein Unterstrich vor den eigentlichen Varablennamen hinzugefügt
Hinweis
Die zweite Variable soll die Schriftgröße speichern und wird dafür mit folgenden Werten erstellt:
Name: hallowelt_schriftgroesse
Gewichtung: 2
Titel: Schriftgröße des Willlkommens-Textes
Beschreibung: Bitte geben Sie hier die gewünschte Schriftgröße ein. (z.B. 12px)
Hidden: Nein
Type: Chars
Chars: 12px //standardwert
Abbildung 1: Konfigurations-Variablen im "Plugin bearbeiten"-Modus
Der Administrator kann nun in den Einstellungen des Plugin die Werte der Konfigurationsvariablen bei Bedarf anpassen:
Abbildung 2: Konfigurations-Variablen nach der Installation des Plugins
In dieser Version des Plugins werden auch keine Daten gespeichert. Es werden daher auch keine Datenvariablen benötigt.
Plugin Elemente füllen
Damit die Einstellungen des Administrators auch umgesetzt werden, müssen wir natürlich das Plugin Template "obere leiste" entsprechend bearbeiten.
Genau wie andere Template-Variablen werden Plugin-Variablen immer über doppelte geschweifte Klammern gekennzeichnet. Der Name der Variable wird dabei immer nach dem gleichen Muster erzeugt:
{{plugin_pluginid_variablentyp_variablenname}}Auf die Konfigurationsvariable hallowelt_schriftgroesse können wir daher über folgenden aufruf zugreifen:
{{plugin_hallowelt_config_hallowelt_schriftgroesse}}Damit man sich diese langen Variablennamen nicht merken muss gibt es eine einfache Möglichkeit, den Namen ins Template zu übernehmen.
Dazu muss man nur mit der Maus über den Text "Config Variablen" in der oberen rechten Ecke fahren - schon öffnet sich ein Fenster, welches alle Konfigurationsvariableen auflistet.
Durch einen Klick auf TPL-Insert wird der Template-Code automatisch in das Plugin-Template eingefügt.
JS-Insert erzeugt übrigens einen Javascript-Code, der die Variable per Javascript zur Laufzeit lädt. Das ist aber Teil eines anderen Tutorials
Abbildung 3: Konfigurations-Variablen einfügen
Damit die Einstellungen des Admins auch greifen übernehmen wir die Werte der Config-Variablen in den Code:
1
2
3
4
5
6
7
8
9
10
11
<div style="text-align:{{plugin_hallowelt_config_hallowelt_ausrichtung}}">
{{user_registered==true.start}}
Hallo {{user_name}}<br/>
Willkommen im Forum<br/><br/>
{{user_registered==true.else}}
Hallo lieber Besucher<br/>
Bitte <a href="/anmeldung.php">melde dich an</a>, um alle Bereiche des Forum zu sehen.<br/><br/>
{{user_registered==true.end}}
</div>
Fertig
Nun sollte auf jeder Seite des Forums ein Text ausgegeben werden.
Mitglieder werden mit ihrem Benutzernamen begrüßt, Gästen wird der Link zur Anmeldung angezeigt.
Fertige Anzeige im Forum
Du willst es noch genauer wissen?
Weiter geht's im zweiten Teil des Tutorials:
Hinweis
