Les services
Elementum propose une architecture basée sur des services qui simplifient l'accès aux fonctionnalités essentielles du framework. Ces services suivent le modèle d'inversion de contrôle (IoC) pour une meilleure gestion des dépendances.
Qu'est-ce qu'un service ?
Un service dans Elementum est une classe qui encapsule une fonctionnalité spécifique du framework. Il offre une interface claire pour interagir avec cette fonctionnalité de manière isolée et testable. Les services sont conçus pour être réutilisables.
Services disponibles
Elementum fournit plusieurs services prêts à l'emploi, enregistrés dans le conteneur de services au boot du kernel.
Services principaux
| Service | Constante | Description |
|---|---|---|
elementum/router | Router::NAME | Gestion avancée du routage des requêtes |
elementum/twig | TwigService::NAME | Moteur de template avec support de l'héritage et des composants |
elementum/config | Config::NAME | Gestion centralisée de la configuration YAML |
elementum/api | Api::NAME | Création et gestion des endpoints REST API |
elementum/post.types | PostTypes::NAME | Déclaration et gestion des types de contenu personnalisés |
elementum/templates | Templates::NAME | Gestion des templates avec remplacement de la hiérarchie WordPress |
elementum/templates.components | Components::NAME | Système de composants réutilisables |
elementum/customize | Appareance::NAME | Gestion du Customizer WordPress |
elementum/bridge.function | BridgeFunction::NAME | Fonctions de pont WordPress/Elementum |
Services d'administration
| Service | Constante | Description |
|---|---|---|
elementum/admin.pages | AdminPages::NAME | Gestion des pages d'administration |
elementum/admin.menu | AdminMenu::NAME | Gestion des menus dans l'admin WordPress |
elementum/admin.bar | AdminBar::NAME | Personnalisation de la barre d'administration |
elementum/dashboard.widgets | Widgets::NAME | Gestion des widgets du tableau de bord |
elementum/dashboard.alerts | Alerts::NAME | Système de notifications pour l'administration |
elementum/plugins | Plugins::NAME | Gestion des extensions et de leurs dépendances |
elementum/roles | Roles::NAME | Gestion des rôles et des capacités utilisateurs |
Services avancés
| Service | Constante | Description |
|---|---|---|
elementum/flashbag | FlashBag::NAME | Messages flash pour les notifications utilisateur |
elementum/editor.blocks | Blocks::NAME | Création et gestion des blocs Gutenberg |
elementum/editor.colors | Colors::NAME | Gestion de la palette de couleurs pour l'éditeur Gutenberg |
elementum/twig.hook | Hook::NAME | Système de hooks pour les composants Twig |
La constante ControllerResolver::NAME est également enregistrée pour la résolution des contrôleurs, mais son usage est interne au framework.
Utilisation des services
Dans les contrôleurs
Les contrôleurs d'Elementum disposent d'un accès simplifié aux services principaux via des méthodes dédiées :
use Elementum\Services\Router\Router; // Via le conteneur de services global $kernel; $router = $kernel->getService(Router::NAME);
Lister les services disponibles
global $kernel; $services = $kernel->container->getServices();
Créer un service personnalisé
Pour créer un service personnalisé, utilisez la commande Dobby dédiée qui génère automatiquement un squelette de service avec le pattern Singleton.
php dobby make:service Logger php dobby make:service Logger plugins/mon-plugin
- La commande génère une classe avec le trait
Singleton:
<?php namespace App\Service; use Elementum\Trait\Singleton; use Elementum\Interfaces\ServiceInterface; class LoggerService implements ServiceInterface { use Singleton; public const NAME = 'project/logger'; public function doSomething() { // Votre logique métier ici } }
- Enregistrez le service dans le conteneur :
#[Kernel('services')] public function registerServices(\Elementum\Container $container): void { $container->addService( LoggerService::NAME, [LoggerService::class, 'getInstance'], args: [], priority: 200 ); }
Si votre service n'a pas vocation a être utiliser en dehors de son plugin, vous pouvez vous abstenir de l'enregistrer.
Utiliser simplement la méthode getInstance() pour obtenir une instance unique.
Gestion des priorités
La priorité détermine l'ordre d'exécution des services. Plus la valeur est élevée, plus le service sera exécuté tardivement. Elle est automatiquement gérée par le système de conteneur de services mais peut être ajustée si nécessaire.
Bonnes pratiques
- Utilisez toujours la constante
NAMEpour référencer un service - Documentez vos services personnalisés avec PHPDoc
Exemple complet
<?php namespace App\Service; use Elementum\Trait\Singleton; use Elementum\Interfaces\ServiceInterface; class LoggerService implements ServiceInterface { use Singleton; public const NAME = 'elementum/logger'; public function log(string $message, string $level = 'info'): void { // Implémentation de la journalisation error_log("[$level] $message"); } }
#[Kernel('services')] public function registerServices(\Elementum\Container $container): void { $container->addService( LoggerService::NAME, [LoggerService::class, 'getInstance'] ); } // Utilisation dans un contrôleur public function index() { $this->getService('logger')->log('Page d\'accueil chargée'); return $this->render('home.twig'); }