Guide développeur
Architecture
sSettings est un module manager basé sur evo-ui et Livewire.
Éléments principaux:
Seiger\sSettings\sSettingsServiceProviderenregistre les traductions, le plugin, le module manager, les routes, les vues, les fichiers publiés et les composants Livewire.Seiger\sSettings\Livewire\ModulePanelbascule entre Paramètres et Configuration.Seiger\sSettings\Livewire\SettingsPanelrend l'éditeur compact des valeurs.Seiger\sSettings\Livewire\ConfigurePanelrend le builder compact du schéma.Seiger\sSettings\Support\SettingsSchemaRepositorylit, normalise et écrit le schéma de manière sûre.Seiger\sSettings\Support\SystemSettingsStorelit et écrit les paramètres systèmesset_*.Seiger\sSettings\Support\FieldCatalogcontient le catalogue des types de champs.
Installation
Dans le dossier core d'Evolution CMS:
php artisan package:installrequire seiger/ssettings "^2.0"
php artisan vendor:publish --provider="Seiger\\sSettings\\sSettingsServiceProvider"
Dans les environnements Extras locaux, le paquet peut aussi être installé comme path repository avec un symlink vers le demo core.
Fichiers de configuration
Schéma par défaut du paquet:
config/sSettingsSettings.php
Schéma projet modifiable:
core/custom/config/seiger/settings/sSettings.php
Si le schéma projet n'existe pas, sSettings utilise le schéma par défaut du paquet.
Forme du schéma
return [
'basicTab' => [
'label' => 'sSettings::global.basicTab',
'fields' => [
[
'name' => 'email',
'label' => 'sSettings::global.email',
'description' => 'sSettings::global.email_description',
'type' => 'text',
],
],
],
];
Les libellés traduits connus sont normalisés vers leurs clés de traduction lors de l'enregistrement. Les libellés personnalisés sans traduction sont conservés comme texte.
Écriture sûre du schéma
SettingsSchemaRepository::save() vérifie le PHP généré avec
token_get_all(..., TOKEN_PARSE) dans le processus PHP courant, puis écrit un
fichier temporaire et remplace le fichier cible. Le code généré n'est pas exécuté
et aucun processus enfant n'est lancé. Cela fonctionne avec PHP-FPM/FastCGI et
exec() désactivé. Un échec de validation ou de remplacement conserve la
configuration existante.
Après l'enregistrement, SystemSettingsStore::syncSchema() synchronise les
paramètres système: les nouveaux sset_* sont créés, et les anciens sset_*
absents du schéma sont supprimés.
Types de champs
FieldCatalog prend en charge:
texttextareatextareaminiimagefilecheckboxdivider
Tous les types sauf divider stockent une valeur. Checkbox est normalisé en
1 ou 0; les autres valeurs deviennent des chaînes trimées. Image et File
stockent le chemin sélectionné comme chaîne.
Routes et module manager
Les routes sont chargées uniquement en manager mode:
GET ssettings
GET ssettings/configure
Le module manager est enregistré comme hidden et ouvert depuis le menu Tools. L'icône du menu utilise le même chemin Blade Tabler icon que l'enregistrement du module.
Contrats evo-ui
L'interface doit rester compacte:
- les valeurs sont groupées par onglets du schéma;
- dans Configuration, l'ajout d'onglet est à gauche et l'enregistrement à droite;
- Configuration est un staged editor: les modals de champ appliquent un draft local, et le bouton Save principal est la seule action de persistance schema;
- l'action primaire du modal de champ utilise
evo::global.action_apply, reste inactive tant que le draft est propre, puis marque Configure comme dirty; - les onglets et champs se réordonnent par poignées de déplacement;
- les options dans les modals de champ utilisent EvoUI
data-evo-dnd-option-listetdata-evo-dnd-option-row; EvoUI possede le chemin pointer reorder, tandis que les lignes, handles et inputs restentdraggable="false"afin d'eviter les races entre modale et native DnD. Alpine ecouteevo-ui:dnd-option-changed; ne pas utiliser de noms d'evenementsx-onavec des points pour ce chemin; - le DnD des onglets et champs Configure ecoute EvoUI
evo-ui:form-dirtyafin d'activer immediatement le bouton Save principal avant la fin du redraw Livewire; - apres un Configure Save reussi,
ssettings-schema-savedrafraichit les settings tabs superieurs depuis le schema normalise sans reload; - les paramètres de champ s'ouvrent dans un modal compact;
- les type chips et system key chips sont petits et compatibles avec le thème.
Le comportement propre à sSettings doit rester dans sSettings. Seuls les manager primitives réutilisables doivent être déplacés vers evo-ui.
Tests et 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
Commandes utiles dans le demo core:
php artisan package:discover
php artisan view:clear
php artisan route:list --path=ssettings