templateListener.xml

This site uses cookies. By continuing to browse this site, you are agreeing to our Cookie Policy.

  • Durch Templatelistener ist es möglich bestehende Templates zu erweitern oder zu manipulieren.

    Table Of Contents

    Durch die templateListener.xml ist es möglich Templatelistener innerhalb des WSC zu registrieren und entsprechend auszuführen. Ein Templatelistener hat zur Aufgabe HTML oder JavaScript an gewissen Stellen innerhalb eines bestehenden Templates auszuführen ohne die Templates direkt bearbeiten zu müssen. Die templateListener.xml wird wie alle PIP Dateien in xml geschrieben und sollte "templateListener.xml" heißen.

    Die XSD auf GitHub


    github.com/WoltLab/WCF/blob/master/XSD/templateListener.xsd

    Package.xml



    Innerhalb der package.xml kann man der Installations- bzw. der Updateroutine durch folgenden instruction-Tag sagen, dass nun ein oder mehrere Templatelistener installiert bzw. geupdatet werden soll(en).

    XML Source Code

    1. <instructions type="install">
    2. <instruction type="templateListener" />
    3. </instructions>



    Mögliche Parameter



    TagParameterDefinition
    <data>-Einleitendes Elternelement
    <import>-Element zum Import neuer Templatelistener
    <delete>-Element zum Löschen von bestehenden Templatelistener
    <templatelistener>name="nameDesTemplateListener"Begrenzungselement um verschiedene Templatelistener zu verarbeiten
    <templatename>-Name des Templates, welches manipuliert werden soll
    <eventname>-Eventname in dem Zieltemplate, in dem wir uns einklinken wollen
    <templatecode>-HTML und/oder JavaScript welches ausgeführt werden soll
    <niceValue>-Gibt die Reihenfolge der Abarbeitung von Templatelistener an (minimal -128, maximal 127). Gibt es zwei oder mehr Templatelistener mit demselben niceValue werden diese der Reihenfolge der Installierung der Plugins ausgeführt.
    <inherit>-WEG
    <environment>-Gibt an, ob der Templatelistener innerhalb des Backend (ACP) oder im Frontend (Endanwendung) ausgeführt werden soll (user/admin).


    Beispiel templateListener.xml


    XML Source Code: templateListener.xml

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/2019/templateListener.xsd"
    3. <import>
    4. <!-- user -->
    5. <templatelistener name="userInformationStatistics">
    6. <environment>user</environment>
    7. <templatename>userInformationStatistics</templatename>
    8. <eventname>statistics</eventname>
    9. <templatecode><![CDATA[{include file='__userInformationStatistics' application='foo'}]]></templatecode>
    10. </templatelistener>
    11. <!-- /user -->
    12. </import>
    13. </data>
    Display All





    Gut zu wissen


    • Man kann sich in jedes Template einklinken, in dem ein Event-Prefilter definiert ist.
    • Im Templatecode-Tag kann direkt HTML oder JavaScript hineingeschrieben werden. Bei mehreren Zeichen allerdings empfiehlt es sich, die include-Funktion zu verwenden. Das eingebundene Template muss dann über das Template-PIP installiert werden.
    • Sollten Sie sich in ein Plugin eines Entwicklers einklinken wollen, scheuen sie nicht davor, ihm ein passendes Event vorzuschlagen, wo sie sich einklinken möchten.


    Ihr habt Fragen oder Anregungen? Lob oder Kritik? Lasst es mich doch durch einen Kommentar von euch wissen!

    30,863 times viewed