Sylius Media Alt Text
Lokalisierte Alt-Texte für Produkt-, Kategorie- und Avatar-Bilder in Sylius 2 - Pflege im Admin und per Admin API, Ausgabe in Storefront und Shop API, dekorative Bilder, Backfill-Befehl.
Sylius Media Alt Text
Diese Dokumentation bezieht sich immer auf die aktuellste veröffentlichte Version.
Überblick
Sylius hat kein Alt-Text-Feld an Bildern. Dieses Plugin ergänzt es für Produktbilder, Kategoriebilder (Taxons) und die Profilbilder der Admin-Benutzer: Redakteure pflegen pro Bild und Sprache einen Alt-Text im Admin oder über die Admin API, Storefront und Shop API geben ihn aus. Damit erfüllst Du den Teil von WCAG 2.1 „Nicht-Text-Inhalte“ und BFSG, der Bilder betrifft.
Ohne gepflegten Text ändert sich nichts: Die Ausgabe bleibt, was Sylius vorher gedruckt hat (der Produkt- bzw. Kategoriename). Du kannst das Plugin also einbauen und die Texte nach und nach ergänzen.
Das Plugin allein macht einen Shop nicht BFSG-konform. Es schließt die Lücke, dass Sylius an Bildern gar kein Alt-Text-Feld hat, der Rest des Shops braucht weiterhin ein echtes Barrierefreiheits-Audit.
graph LR
A["Redakteur im Admin"] --> D["Alt-Texte pro Bild und Sprache"]
B["Admin API"] --> D
C["Backfill-Befehl"] --> D
D --> E["Storefront (Twig)"]
D --> F["Shop API (alt)"]
Dokumentation
| Seite | Inhalt |
|---|---|
| Installation | Composer, Bundle, Routen, Setup-Befehl, Update, Deinstallation |
| Konfiguration | Schalter im Admin, Alt-Texte pflegen, Backfill-Befehl |
| Storefront | Wo der Text erscheint, Template-Overrides, mmd_image_alt im eigenen Theme |
| Shop API | Feld alt in Shop-API-Antworten, Einstellungs-Endpunkt für Headless-Clients |
| Admin API | alt, decorative und altTexts lesen und schreiben, Fehlerantworten |
| Erweiterbarkeit | Fallback-Provider, weitere Bildtypen, Services |
| Fehlerbehebung | Typische Probleme, Einschränkungen, FAQ |
| Technik | Architektur, Struktur, Tabellen |
Features
| Feature | Beschreibung |
|---|---|
| Alt-Text pro Sprache | Ein Text je Bild und aktivierter Shop-Sprache, maximal 255 Zeichen |
| Dekorative Bilder | Schalter „Dekoratives Bild“: Das Bild gibt alt="" aus und wird von Screenreadern übersprungen |
| Drei Bildtypen | Produktbilder, Kategoriebilder (Taxons) und Admin-Avatare |
| Admin-Editor | Direkt in der Bild-Karte, eine ausklappbare Sektion je Sprache, die Standardsprache startet offen |
| Admin API | Bilder liefern alt, decorative und altTexts, PUT und Multipart-Upload nehmen altTexts und decorative an |
| Shop API | Bilder liefern das aufgelöste alt für die Sprache der Anfrage |
| Storefront | Produktseite, Kategorie-Kopfbild, Produktkarten und Warenkorb geben den gepflegten Text aus |
| Fallback | Angefragte Sprache, dann Standardsprache, dann der Name von Produkt bzw. Kategorie |
| Backfill | mmd:media-alt-text:backfill füllt fehlende Texte aus den Produkt- und Kategorienamen vor |
| Globaler Schalter | Eine Einstellung schaltet die Ausgabe für den ganzen Shop ein oder aus |
Anforderungen
| Anforderung | Version | Hinweise |
|---|---|---|
| PHP | 8.3 oder neuer | |
| Sylius | 2.2 oder neuer | Symfony 7.4 |
| Datenbank | MySQL 8 / MariaDB | Die Migrationen sind MySQL-DDL und verweigern den Lauf auf anderen Plattformen |
Lizenz
Kommerzielle Lizenz, siehe LICENSE im Repository.
Support
E-Mail: support@markus-michalski.net