Yaml
Le helper Yaml permet de charger et manipuler des fichiers de configuration YAML dans Elementum.
Installation
use Elementum\Helpers\Yaml;
Méthodes
config(string $path): array
Charge un fichier de configuration YAML et retourne son contenu sous forme de tableau.
Paramètres :
$path(string) : Chemin vers le fichier YAML (relatif au dossierconfig/)
Retourne : array - Contenu du fichier YAML
Exemple :
// Charge config/site.yaml $config = Yaml::config('site.yaml'); // Charge un fichier dans un sous-dossier $settings = Yaml::config('settings/general.yaml'); // Accès aux valeurs $siteName = $config['site_name']; $logo = $settings['logo']['url'];
Cas d'usage
Dans un contrôleur
use Elementum\Helpers\Yaml; use Elementum\Attributes\Template; class HomeController { #[Template('home.html.twig')] public function index(): array { $config = Yaml::config('site.yaml'); return [ 'siteName' => $config['site_name'], 'socialLinks' => $config['social'] ]; } }
Chargement de configuration personnalisée
use Elementum\Helpers\Yaml; // Dans un service class SettingsService { private array $settings; public function __construct() { $this->settings = Yaml::config('settings.yaml'); } public function get($key, $default = null) { return $this->settings[$key] ?? $default; } }
Structure des fichiers YAML
Exemple de fichier config/site.yaml :
site_name: "Mon Site" description: "Description du site" logo: url: "/assets/logo.png" alt: "Logo" social: facebook: "https://facebook.com/..." twitter: "https://twitter.com/..."
Bonnes pratiques
- Emplacement : Placez vos fichiers YAML dans le dossier
config/de votre thème ou plugin - Nommage : Utilisez des noms de fichiers explicites (ex:
site.yaml,settings.yaml) - Cache : Les fichiers YAML sont mis en cache par Elementum pour de meilleures performances