Backend-Module

Diese Beschreibung richtet sich an Modulentwickler!

Ab Version 2.0 können Sie jQueryAdmin auch für Ihre Backend-Module verwenden. Hierzu wird eine Funktion zur Verfügung gestellt, die Sie einfach an passender Stelle (üblicherweise am Ende der Seite) aufrufen.

Preset erstellen

Um jQuery Komponenten mit Hilfe von jQueryAdmin verwenden zu können, müssen Sie ein Preset erstellen.

  • Legen Sie ein Unterverzeichnis presets oder jquery/presets im Basisverzeichnis Ihres Moduls an.
  • Legen Sie dort eine Datei default.jquery an.

Sobald diese Datei existiert, können Sie sie im jQueryAdmin Admin Tool bearbeiten. Das funktioniert genauso wie im Frontend. (Siehe Verwendung)

Wichtig!

Wenn Sie die Komponenten zusammengestellt haben, die Sie verwenden wollen, werden Sie vermutlich noch eigenen Code hinzufügen. Damit dieser bei einer Bearbeitung des Presets mit jQueryAdmin erhalten bleibt, müssen Sie ihn folgendermaßen maskieren:

    <!-- custom -->
    ...Ihr Code...
    <!-- end custom -->

Alles, was innerhalb dieser Markierungen steht, bleibt bei einer Bearbeitung des Presets mit dem Admin Tool erhalten.

jQueryAdmin einbinden

Um Ihr Preset im Backend einbinden zu können, stellt jQueryAdmin die Funktion jQueryAdmin_backendPreset() zur Verfügung. Um diese verwenden zu können, müssen Sie folgendermaßen vorgehen:

  • include.php einbinden
    include_once WB_PATH.'/modules/jqueryadmin/include.php';
  • Funktion aufrufen
    echo jQueryAdmin_backendPreset( '<Modulname>' );

<Modulname> ersetzen Sie natürlich durch den Namen Ihres Moduls. Üblicherweise sollten Sie die Ausgaben Ihres Moduls mit diesem Aufruf abschließen, es kann aber auch sinnvoll sein, das Preset am Anfang oder an anderer Stelle auszugeben.

Mit dem o. g. Aufruf wird eine Datei default.jquery gesucht und geladen, analog zum Frontend. Wenn Sie Ihr Preset anders nennen wollen - etwa backend.jquery -, geben Sie den Namen als zweiten Parameter an:

  echo jQueryAdmin_backendPreset( '<Modulname>', 'backend' );

jQueryAdmin sorgt dafür, daß der JavaScript-Code an die richtigen Stellen der Seite verteilt wird. Zudem wird die jQuery Core Datei aus dem WebsiteBaker inc Verzeichnis deaktiviert, damit es nicht zu Problemen kommt. Da WebsiteBaker derzeit kein jQuery im Backend verwendet, sollte es hierdurch zu keinen unerwünschten Seiteneffekten kommen. (Das kann sich natürlich in Zukunft noch ändern. jQueryAdmin wird dann nötigenfalls angepaßt.)