app:plugin:validate
- Manifest: Pflichtfelder, Formate, Namensregeln, Anforderungen (
requires), vorhandene Dateien unterassets,PrivacyAwarebeiprivacy.personalData. - Code: Die Einstiegsklasse und alle Klassen unter
src/werden in einem eigenen PHP-Prozess geladen. Ein Syntaxfehler oder eine fehlende Klasse irgendwo untersrc/macht das Plugin unbrauchbar – auch wenn die Klasse selten benutzt wird. - Dateirechte: wie beim Laden in Produktion (Status „unsicher“), außer die Prüfung ist abgeschaltet.
- Migrationen: Dateinamen, Zerlegung in Anweisungen, erlaubtes SQL (siehe Datenbank und Migrationen), Warnung bei
CREATE TABLEohnecommunity_idund bei nicht idempotenten Anweisungen, Prüfsummen bereits ausgeführter Dateien gegen die Datenbank. - Oberfläche: gebautes
dist/nach denselben Regeln wienpm run build:pluginsundfrontend/*.css(Verweis auf das Theme, siehe Frontend-SDK → Bauen). - Vorlagen:
|raw,{% apply raw %},{% autoescape false %},source(),template_from_string()und das Einbinden fremder Vorlagen intemplates/sind Fehler – schon beim Laden, das Plugin ist dann nicht ladbar (Kommentare zählen nicht). Fürtemplates/blocksundtemplates/formswarnt die Prüfung außerdem bei fehlendem@sourceinfrontend/plugin.css.
Statische Prüfungen
Die Werkzeuge der Entwicklungsumgebung schließenplugins/* ein: PHPStan (Stufe 8) mit eigenen Regeln für Plugins (siehe Grenzen und Regeln), eine Architekturprüfung (Plugins hängen nur von App\Plugin\Api, eigenen Klassen, Psr\Log, Psr\Clock, Doctrine\DBAL, Symfony\Component\Uid und PHP selbst ab), php-cs-fixer, ESLint (u. a. ohne v-html und nur erlaubte Importe), Prettier und vue-tsc. Sie laufen über das ganze Projekt, z. B. vendor/bin/phpstan analyse und npm run lint.
PHPUnit mit dem Testkit
Tests liegen unterplugins/<id>/tests/ im Namespace <Namespace>\Tests\ und gehören zur Testsuite plugins. Ausführen in der Entwicklungsumgebung – immer mit APP_ENV=test:
App\Tests\Support\Plugin\PluginTestCase. Sie laufen gegen eine eigene Test-Datenbank mit zwei Communities, testcom und othercom, und den Konten $this->owner, $this->moderator, $this->member, $this->mutedMember und $this->outsider. Die Migrationen der Plugins unter plugins/ laufen vor dem ersten Test automatisch.
- Pflicht je Endpunkt: ein Test für den Normalfall, für Validierung (
422), für Berechtigung (401/403/404) und für die Mandantentrennung – derselbe Aufruf aus bzw. gegenothercomliefert nie Daten austestcom. - Aktivieren führt im Test keine Migrationen aus; sie laufen vorab für alle Plugins in
plugins/. - Im Test laufen Aufgaben sofort. Schickt ein Handler während eines Requests eine Aufgabe ab, läuft sie deshalb innerhalb dieses Requests: Community und handelnde Person sind wie im Worker, aber der Request wartet auf die Aufgabe, und ihr Fehler steht nur im Log (
plugin.<id>.task_failed). Ergebnis und Fehler einer Aufgabe prüft man mitrunTask()/runTaskOrFail(). - Plugin-Klassen ohne Kern-Abhängigkeit (Berechnungen, Formatierungen) testet man als gewöhnliche Unit-Tests.
- Forderungen ohne Kern (ab Plugin-API 1.1): siehe Forderungen ohne Kern testen.
Forderungen ohne Kern testen
Ab Plugin-API 1.1 ersetztApp\Tests\Support\Plugin\InMemoryDebits den Dienst debits() in Unit-Tests. Die Attrappe verhält sich wie der echte Dienst – derselbe Vertragstest (tests/Support/Plugin/DebitsContract) läuft gegen beide: Idempotenz über die Referenz, Formfehler, Storno-Regeln, Teilausgleich, Überfälligkeit gegen die Uhr, Akteur, Limits, GET-Sperre und Hooks nur an die eigene Quelle. Übergib dem eigenen Code die Attrappe dort, wo er sonst $ctx->debits() nutzt (zum Beispiel über einen Konstruktor-Parameter vom Typ App\Plugin\Api\Service\Debits).
Für
standings() braucht der Test einen App\Plugin\Api\Model\Viewer; im Test darf er ihn selbst erzeugen (im Plugin-Code kommt er immer vom Kern). Integrationstests gegen den echten Dienst schreibt man mit PluginTestCase und pluginContext($id)->debits().
Playwright
Browser-Tests liegen unterplugins/<id>/tests/e2e/*.spec.ts und laufen in eigenen Projekten (plugins-chromium, plugins-mobile) mit den Tests der Plattform, z. B. docker compose exec app npx playwright test --project=plugins-chromium bzw. für ein Plugin docker compose exec app npx playwright test plugins/<id>/tests/e2e. Die Demo-Daten der Entwicklungsumgebung (php bin/console app:fixtures:load) aktivieren alle erkannten Plugins plattformweit und in der Community demo. Jede Datei muss für sich allein bestehen (die Tests laufen verteilt), und Konsolenfehler oder Verstöße gegen die Sicherheitsrichtlinie gelten als Fehler. Die Helfer der Plattform (login, joinDemo …) stehen in tests/e2e/helpers.ts; aus plugins/<id>/tests/e2e/ heißt der Import ../../../../tests/e2e/helpers. Ein vollständiges Szenario zeigt tests/e2e/bring-list.spec.ts im Beispiel-Plugin.
Übersetzungen
Deutsch ist Quelltext und Schlüssel: Texte stehen auf Deutsch im Code, mit Platzhaltern wie{name}. Englisch steht in translations/messages.en.json:
{count, plural, one {…} other {…}}): PHP und Twig könnten ihn formatieren, die Oberfläche (sdk.t()) nicht – dort wirft ein solcher Text einen Fehler, die Komponente scheitert, und das Plugin verschwindet aus allen Slots der Seite. Einzahl und Mehrzahl stehen deshalb wie in QuickTribe selbst als eigene Texte, die Auswahl trifft der Code: in Vue count === 1 ? t('Ein freier Platz') : t('{count} freie Plätze', { count }), in PHP z. B. mit match.
Dieselbe Datei nutzen
- PHP – Meldungen von Ausnahmen, Benachrichtigungen, Seitentitel, Menüpunkte, Feld- und Einstellungsnamen, Hinweise und
translator()->trans(); ohne Eintrag gilt der Katalog der Plattform, sonst bleibt der deutsche Text; - Twig-Vorlagen für E-Mail und PDF über den Filter
ptrans(in der Sprache des Empfängers); - die Oberfläche über
sdk.addMessages('en', en)undsdk.t().
npm run build:plugins warnt, npm run i18n:check scheitert bei t('…')-Texten der Oberfläche ohne englischen Eintrag.