Symfony : Utiliser un fichier de config personnalisé

Lorsque l’on développe un projet, on a (presque?) toujours un certain nombre de paramètres propres à ce dernier. Cela peut-être le nom du site internet, la clé d’accès à un WebService ou encore la taille des miniatures à générer. De façon générale, il s’agit de tous ces paramètres communs à la fois au frontend et au backend du projet.

Tout bon développeur qui se respecte, je ne laisserai pas ce genre de paramètre perdu dans la logique métier. Tout d’abord parce que ça n’a absolument rien à faire là et ensuite parce qu’il ne serait pas facile de modifier le paramètre plus tard. Une bonne pratique est donc de créer un fichier à part pour stocker ces paramètres…

Dans symfony, il y a un fichier de paramètres pour les applications (apps/monapp/config/app.yml) et un pour les modules (apps/monapp/modules/monmodule/config/module.yml) mais pour tout le projet il n’y aucun fichier pré-défini par défaut. Heureusement, symfony est un framework très flexible et l’on peut ainsi ajouter un nouveau fichier de config en quelques lignes seulement…

Pour les intéressés, voici la procédure :

1. Créez un fichier nommé config_handlers.yml dans le dossier config
2. Copiez dans le fichier précédemment créé le code ci-dessous :

   config/project.yml:
     class:		sfDefineEnvironmentConfigHandler
     param:
       prefix: project_

3. Créez le fichier config/project.yml et ajoutez quelques paramètres. Par exemple :

   all:
     website:
       name: Mon site internet

4. Il faut maintenant charger les paramètres pour chaque application du projet.
   • Modifiez le fichier config/ProjectConfiguration.class.php
   • Ajoutez une fonction loadProjectConfig :

     	protected function loadProjectConfig()
     	{
     		static $load = false;
      
     		if (!$load && $this instanceof sfApplicationConfiguration)
     		{
     			require $this->getConfigCache()->checkConfig('config/project.yml');
     			$load = true;
     		}
     	}

   • Chargez le fichier de config en ajoutant le code ci-dessous dans la méthode setup de la classe :

     			$this->loadProjectConfig();

5. C’est fini !

Vous pouvez maintenant, dans les applications de votre projet, accéder aux paramètres définis dans project.yml en utilisant sfConfig::get('project_...').

Attention, si comme moi vous écrivez des tests automatisés pour vos projets, pour les tests unitaires, il faudra ajouter un ligne afin de charger le fichier de config personnalisé :

$configuration = ProjectConfiguration::getApplicationConfiguration('frontend', 'test', true);

Je vous conseille d’ailleurs d’écrire un bootstrap avec cette ligne plutôt que de la copier/coller dans chaque fichier de test