Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FairPlay Client

Ruft die FairPlay-Tabelle eines Verbandes über die öffentliche JSON-API einer zentralen fairplay_tabellen-Installation ab und gibt sie mit UIkit3-Markup auf der eigenen REDAXO-Website aus – gecacht, ohne API-Token.

Gegenstück / Datenquelle: das Addon fairplay_tabellen (README_API.md, Abschnitt "Öffentliche Tabellen-API", ?rex-api-call=fairplay_tabelle&format=json).

Einrichtung

  1. Addon installieren und aktivieren.
  2. Unter FairPlay Client > Einstellungen:
    • API-Basis-URL der zentralen Installation eintragen (z. B. https://fairplay-zentrale.example.de, ohne abschließenden Slash).
    • Verband-Kürzel eintragen (z. B. FVN).
    • Speichern, dann über Verbindung testen prüfen.
    • Optional Standard-Filter (Liga/Mannschaftsart/Staffel/Limit), Anzeige-Optionen und Cache-Dauer anpassen.

Verwendung

In einem REDAXO-Modul (Ausgabe) oder direkt im Template:

<?= FairplayClientRenderer::render() ?>

Mit Filtern/Optionen für diese eine Einbindung (überschreiben die Standard-Einstellungen nur lokal):

<?= FairplayClientRenderer::render([
    'liga' => 'Frauen Niederrheinliga',
    'limit' => 25,
    'columns' => ['fairplay_punkte', 'quotient'],
]) ?>

Verfügbare Optionen: base_url, verband, liga, staffel, mannschaftsart, limit, saison (Archiv-Slug, z. B. 2025-2026), title, show_title, show_calculation_info, columns, cache_minutes.

Spaltenauswahl

Platz und Mannschaft werden immer angezeigt. Welche weiteren Spalten dazukommen, wird unter Einstellungen > Anzeige per Checkbox festgelegt (Standard: alle außer den dynamischen CSV-Zusatzfeldern) und lässt sich pro Einbindung über die Option columns überschreiben:

'spiele', 'gelb', 'gelb_rot', 'rot', 'abbrueche', 'ausfaelle',
'sperren', 'ordnungsgeld', 'fairplay_punkte', 'quotient',
'manual_fields', 'dynamic_fields'

manual_fields/dynamic_fields fächern sich automatisch in so viele Spalten auf, wie die API für die jeweilige Liga liefert.

Caching

Antworten werden dateibasiert im addon-eigenen Cache-Verzeichnis abgelegt (Schlüssel aus Basis-URL, Verband und Filtern; TTL aus den Einstellungen, pro Aufruf über cache_minutes überschreibbar). Über den Button Cache jetzt leeren in den Einstellungen wird der komplette Cache dieses Addons gelöscht.

Ausgabe

Die Ausgabe verwendet ausschließlich UIkit3-Klassen (uk-table, uk-alert, uk-badge, uk-label, uk-icon …) und bringt kein eigenes CSS mit – sie fügt sich in das auf den Verbands-Webseiten bereits vorhandene UIkit3 ein. Enthält die API zusätzliche manuelle oder dynamische Felder (z. B. Ordnungsgelder, individuelle CSV-Spalten), werden diese automatisch als Extra-Spalten ausgegeben.

Fehlerverhalten

Ist die API nicht erreichbar oder meldet einen Fehler, wird im Frontend ein allgemeiner Hinweis (UIkit3-Alert) statt der Tabelle angezeigt; Details landen im REDAXO-Systemlog. Fehlt die Konfiguration, erscheint ein entsprechender Hinweis.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages