English Version

Zurück zur Übersicht

Tab Swap: Technische Details

Ablauf

graph TD
    A["osTicket startet, Plugin bootstrap()"] --> B["checkVersion(): installed_version speichern"]
    B --> C{"Enable Tab Swap an?"}
    C -->|"Nein"| D["Kein Signal, kein Script"]
    C -->|"Ja"| E["Signal object.view verbunden"]
    E --> F{"Objekt ist ein Ticket?"}
    F -->|"Nein"| G["Nichts passiert"]
    F -->|"Ja"| H["Inline-Script wird ausgegeben"]
    H --> I["Browser: Tabs tauschen"]

Plugin-Metadaten

Server-Seite

• bootstrap() ruft checkVersion() auf. Ist installed_version leer oder niedriger als die Version aus plugin.php, schreibt performUpdate() die neue Version in die Konfiguration. Eine Meldung ins Error-Log gibt es nur, wenn die Konstante DEBUG gesetzt und wahr ist.
• Ist die Option Enable Tab Swap an, verbindet das Plugin onObjectView() mit dem Signal object.view.
• onObjectView() tut nur etwas, wenn das übergebene Objekt ein Ticket ist (zum Beispiel keine Aufgabe). Dann wird das Script ausgegeben.
• Das Plugin prüft keine Berechtigungen. Es gibt das Script für jede Ticket-Ansicht aus, in der das Signal auftritt. Ob der Tausch greift, entscheiden die Elemente im Browser (siehe unten).
• Es gibt keine Datenbanktabellen, keine Routen, keine Dateikopien und keine Änderungen an osTicket-Dateien.

Ausgegebenes Script

Das Plugin gibt ein Element der Form <script data-plugin="tab-swap" data-version="..." nonce="..."> aus:

• data-version enthält installed_version, aber nur, wenn der Wert dem Muster Zahl.Zahl oder Zahl.Zahl.Zahl entspricht. Sonst wird 1.0.0 eingesetzt. Der Wert wird zusätzlich HTML-escaped.
• nonce wird nur gesetzt, wenn die Konstante CSP_NONCE definiert ist. Der Wert wird HTML-escaped.
• Das Script ist fest im Plugin-Code hinterlegt und enthält keine Nutzereingaben.

Browser-Seite

Das Script wirkt erst, wenn alle Voraussetzungen erfüllt sind:

1. Die Elemente #post-reply-tab, #post-note-tab, #reply und #note existieren.
2. Beide Tabs sind sichtbar (offsetParent ist nicht null).

Dann passiert Folgendes:

1. Das li-Element des Notiz-Tabs wird in #response-tabs vor das li des Antworten-Tabs verschoben.
2. Beim Antworten-Tab wird die Klasse active entfernt und aria-selected="false" gesetzt. Beim Notiz-Tab wird active ergänzt und aria-selected="true" gesetzt.
3. #reply bekommt display: none, #note bekommt display: block.

Der Tausch läuft pro Seitenaufbau einmal. Damit er auch bei später aufgebauten Seiten greift, nutzt das Script:

• einen MutationObserver, der auf #post-reply-tab wartet und nach erfolgreichem Tausch endet,
• einen direkten Aufruf und DOMContentLoaded,
• pjax:success und, falls jQuery vorhanden ist, das Ereignis redraw.staff. In beiden Fällen wird der Zustand zurückgesetzt und der Tausch erneut ausgeführt.

jQuery ist nicht zwingend nötig. Fehlt es, entfällt nur die Reaktion auf redraw.staff.

Dateistruktur

tab-swap/
├── plugin.php               # Plugin-Metadaten
├── class.TabSwapPlugin.php  # Plugin-Klasse, Signal-Handler, Inline-Script
└── config.php               # TabSwapConfig mit den zwei Feldern

Im Repository liegen zusätzlich composer.json, PHPUnit-Tests, CI-Workflow und Dokumentation. Die CI prüft Syntax und führt die Tests mit PHP 7.4 bis 8.3 aus.