Zum Hauptinhalt springen

Entwicklerhandbuch

Architektur​

sSettings ist ein evo-ui + Livewire Manager-Modul.

Kernbestandteile:

  • Seiger\sSettings\sSettingsServiceProvider registriert Übersetzungen, Plugin, Manager-Modul, Routen, Views, veröffentlichte Dateien und Livewire Komponenten.
  • Seiger\sSettings\Livewire\ModulePanel wechselt zwischen Einstellungen und Konfiguration.
  • Seiger\sSettings\Livewire\SettingsPanel rendert den kompakten Werteeditor.
  • Seiger\sSettings\Livewire\ConfigurePanel rendert den kompakten Schema Builder.
  • Seiger\sSettings\Support\SettingsSchemaRepository liest, normalisiert und schreibt das Schema sicher.
  • Seiger\sSettings\Support\SystemSettingsStore liest und schreibt sset_* Systemeinstellungen.
  • Seiger\sSettings\Support\FieldCatalog verwaltet die Feldtypen.

Installation​

Im Evolution CMS Verzeichnis core:

php artisan package:installrequire seiger/ssettings "^2.0"
php artisan vendor:publish --provider="Seiger\\sSettings\\sSettingsServiceProvider"

In lokalen Extras-Umgebungen kann das Paket auch als Path Repository mit Symlink in den Demo-Core eingebunden werden.

Konfigurationsdateien​

Paketstandard:

config/sSettingsSettings.php

Schreibbares Projektschema:

core/custom/config/seiger/settings/sSettings.php

Wenn das Projektschema nicht existiert, verwendet sSettings das Standardschema des Pakets.

Schemaformat​

return [
'basicTab' => [
'label' => 'sSettings::global.basicTab',
'fields' => [
[
'name' => 'email',
'label' => 'sSettings::global.email',
'description' => 'sSettings::global.email_description',
'type' => 'text',
],
],
],
];

Bekannte übersetzte Labels werden beim Speichern wieder zu Übersetzungsschlüsseln normalisiert. Eigene Labels ohne Übersetzung werden als Klartext gespeichert.

Sicheres Schreiben des Schemas​

SettingsSchemaRepository::save() prüft den erzeugten PHP-Code mit token_get_all(..., TOKEN_PARSE) im aktuellen PHP-Prozess, schreibt dann eine temporäre Datei und ersetzt die Zieldatei. Der erzeugte Code wird nicht ausgeführt und kein Unterprozess gestartet. Das funktioniert mit PHP-FPM/FastCGI und deaktiviertem exec(). Bei Prüf- oder Ersetzungsfehlern bleibt die bisherige Konfiguration erhalten.

Nach dem Speichern synchronisiert SystemSettingsStore::syncSchema() die Systemeinstellungen: neue sset_* werden erstellt, alte nicht mehr im Schema vorhandene sset_* werden entfernt.

Feldtypen​

FieldCatalog unterstützt:

  • text
  • textarea
  • textareamini
  • image
  • file
  • checkbox
  • divider

Alle Typen außer divider speichern Werte. Checkbox wird zu 1 oder 0 normalisiert, andere Werte zu getrimmten Strings. Image und File speichern den ausgewählten Pfad als String.

Routen und Manager-Modul​

Routen werden nur im Manager Mode geladen:

GET ssettings
GET ssettings/configure

Das Manager-Modul ist als hidden registriert und wird über das Tools-Menü geöffnet. Das Menüicon nutzt denselben Blade Tabler Icon Pfad wie die Modulregistrierung.

evo-ui Verträge​

Die Oberfläche soll kompakt bleiben:

  • Werte sind nach Schema-Tabs gruppiert.
  • In der Konfiguration ist Tab hinzufügen links und Speichern rechts.
  • Configure ist ein staged editor: Feldmodals wenden lokale Draft-Aenderungen an, waehrend der Haupt-Speichern-Button die einzige Schema-Persistenz ist.
  • Die Primaeraktion im Feldmodal nutzt evo::global.action_apply, bleibt bei unveraendertem Draft deaktiviert und markiert Configure nach Apply als dirty.
  • Tabs und Felder werden über Drag Handles sortiert.
  • Optionszeilen in Feldmodals verwenden EvoUI data-evo-dnd-option-list und data-evo-dnd-option-row; EvoUI besitzt den Pointer-Reorder-Pfad, waehrend Optionszeilen, Handles und Inputs draggable="false" bleiben, damit kein Modal/native-DnD Timing-Race entsteht. Alpine hoert ueber evo-ui:dnd-option-changed; keine dotted x-on Event-Namen fuer diesen Pfad verwenden.
  • Configure Tab- und Field-DnD hoert auf EvoUI evo-ui:form-dirty, damit Reorder die Haupt-Speichern-Schaltflaeche sofort aktiviert, noch bevor der Livewire-Redraw fertig ist.
  • Nach erfolgreichem Configure Save aktualisiert ssettings-schema-saved die oberen Settings-Tabs aus dem normalisierten Schema ohne Reload.
  • Feldeinstellungen öffnen sich in einem kompakten Modal.
  • Type Chips und System Key Chips sind klein und theme-aware.

sSettings-spezifisches Verhalten bleibt in sSettings. Nur wiederverwendbare Manager-Primitives gehören nach evo-ui.

Tests und Smoke Checks​

find src plugins module tests config lang -name "*.php" -print0 | xargs -0 -n1 php -l
SSETTINGS_DEMO_CORE=/path/to/demo/core php tests/run.php

Nützliche Demo-Kommandos:

php artisan package:discover
php artisan view:clear
php artisan route:list --path=ssettings