Stockage de la configuration dans Drupal 8

Par défaut, les informations de configuration dans Drupal 8 sont stockées dans la base de données.

Format du fichier de configuration (YAML)

Les extensions (modules, thèmes et profils) fournissent des données de configuration dans des fichiers YAML.

Voici un exemple de fichier de configuration :

some_string: 'Woo kittens!'
some_int: 42
some_bool: true

La configuration peut également être imbriquée. Voici un exemple :

name: thumbnail
label: 'Thumbnail (100x100)'
effects:
  1cfec298-8620-4749-b100-ccb6c4500779:
    id: image_scale
    data:
      width: 100
      height: 100
      upscale: true
    weight: 0
    uuid: 1cfec298-8620-4749-b100-ccb6c4500779

Schéma de configuration

La configuration possède un schéma. Ceci est décrit dans la documentation du schéma de configuration / métadonnées.

Configuration par défaut pour une extension

Une extension (module, thème ou profil) qui fournit des valeurs par défaut pour sa configuration doit placer cette configuration dans des fichiers YAML dans son sous-répertoire config/install.

Si l’extension a seulement besoin de paramètres simples de configuration basique, tous les réglages par défaut peuvent être placés dans un seul fichier modulename.settings.yml. Pour des configurations plus complexes, vous pouvez répartir votre configuration en plusieurs fichiers. Chaque objet de configuration doit être placé dans son propre fichier YAML, et ils doivent être générés automatiquement si le module écrit sa configuration (n’essayez pas de les écrire manuellement).

Pour fournir des valeurs par défaut pour une configuration nécessitant une valeur dynamique (qui ne peut donc pas être définie dans modulename.settings.yml), faites-le dans hook_install(). Par exemple :

/**
 * Implémente hook_install().
 */
function modulename_install() {
  // Définir les valeurs par défaut pour la configuration qui nécessite des valeurs dynamiques.
  \Drupal::configFactory()->getEditable('modulename.settings')
    ->set('default_from_address', \Drupal::config('system.site')->get('mail'))
    ->save();
}

Configuration optionnelle pour une extension

Les éléments optionnels de configuration pour une extension (module ou thème) sont stockés dans le sous-répertoire config/optional.

Ce sont des éléments de configuration qui dépendent de quelque chose dont l’extension elle-même ne dépend pas explicitement, ils sont donc installés seulement lorsque toutes leurs dépendances sont satisfaites.

Par exemple, dans un scénario où le module A a une configuration optionnelle qui nécessite le module B, mais où le module A est installé en premier, puis le module B installé plus tard, le répertoire config/optional du module A sera scanné lors de l’installation de B pour détecter les dépendances nouvellement satisfaites, et la configuration sera alors installée. Si le module B n’est jamais installé, la configuration additionnelle ne sera pas installée non plus.

Stockage de la configuration active

Par défaut, Drupal 8 stocke la configuration active dans la base de données pour des raisons de performance et d’évolutivité. Voir « Configuration active par défaut » qui a été modifiée pour utiliser la base de données plutôt que le stockage fichier pour plus de détails.

Mettre à jour la configuration depuis YAML vers la base de données

Si pendant le développement vous avez besoin de mettre à jour la configuration du YAML vers la base de données, vous pouvez utiliser la commande drush config-import (cim).
Vous modifiez le fichier YAML de configuration dans le dossier de configuration active (tel que défini dans settings.php, par exemple sites/default/files/config_6dh1U_2YKLGrrh5oLxAgobbledygook/sync), puis vous lancez drush cim. Videz le cache (drush cr) pour voir les changements.
Si vous êtes satisfait des réglages dans le fichier YAML, vous pouvez ensuite les copier dans votre module ou thème.