Présentation des fichiers de configuration de module
Les responsabilités du fichier de configuration config.xml utilisé dans les versions antérieures de Commerce sont désormais réparties entre plusieurs fichiers situés dans différents répertoires de module. Le Commerce plusieurs fichiers de configuration charge à la demande uniquement lorsqu’un module demande un type de configuration spécifique.
Vous pouvez utiliser ces fichiers, également appelés types de configuration, pour personnaliser des aspects spécifiques du comportement de votre module.
Plusieurs modules peuvent déclarer des fichiers de configuration qui affectent le même type de configuration (des événements, par exemple), et ces fichiers de configuration multiples sont fusionnés.
Vous trouverez ci-dessous les termes courants utilisés dans cette rubrique :
-
Objet de configuration : bibliothèque ou classe Commerce chargée de définir et de valider le type de configuration. Par exemple, l’objet de configuration pour
config.xmlest Magento\Framework\App\Config. -
Étape de configuration : les étapes sont définies comme primaire, global et area. Chaque étape détermine le moment où le type de configuration est chargé et fusionné avec les types de configuration du même nom. Par exemple, les fichiers
module.xmlsont fusionnés avec d’autres fichiersmodule.xml. -
Étendue de configuration : Complémentaire aux étapes de configuration, une étendue définit le modèle de type de configuration. Par exemple,
adminhtmlest une portée de zone qui est chargée avec à l’étape avec les configurationsadminhtmld’autres modules. Pour plus d’informations, voir Modules et zones.
Chargement et fusion des configurations
Cette section explique comment les fichiers de configuration sont chargés et fusionnés.
Comment Commerce charge les fichiers de configuration
Commerce charge les fichiers de configuration dans l’ordre suivant (tous les chemins d’accès dépendent du répertoire d’installation de Commerce) :
- Configuration de Principal (app/etc/di.xml). Ce fichier est utilisé pour démarrer Commerce.
- Configurations globales des modules (
<your component base dir>/<vendorname>/<component-type>-<component-name>/etc/*.xml). Collecte certains fichiers de configuration de tous les modules et les fusionne. - Configuration spécifique à la zone à partir des modules (
<your component base dir>/<vendorname>/<component-type>-<component-name>/etc/<area>/*.xml). Collecte des fichiers de configuration de tous les modules et les fusionne dans la configuration globale. Certaines configurations spécifiques à une zone peuvent remplacer ou étendre la configuration globale.
where
-
<your component base dir>est le répertoire de base dans lequel se trouve votre composant. Les valeurs types sontapp/codeouvendorpar rapport au répertoire d’installation de Commerce. -
<vendorname>est le nom du fournisseur du composant ; par exemple, le nom du fournisseur Commerce estmagento. -
<component-type>est l’un des suivants :module-: extension ou module.theme-: thème.language-: package de langue.
<magento_root>/app/design/frontend ou <magento_root>/app/design/adminhtml.<component-name>: nom de votre composant tel que défini dans compositeur.json.
Fusion du fichier de configuration
Les noeuds des fichiers de configuration sont fusionnés en fonction de leurs XPath entièrement qualifiés, qui a un attribut spécial défini dans le tableau $idAttributes déclaré comme identifiant. Cet identifiant doit être unique pour tous les noeuds imbriqués dans le même noeud parent.
Algorithme de fusion d’applications Commerce :
- Si les identifiants de noeud sont égaux (ou si aucun identifiant n’est défini), tout le contenu sous-jacent dans le noeud (attributs, noeuds enfants et contenu scalaire) est remplacé.
- Si les identifiants de noeud ne sont pas égaux, le noeud est un nouvel enfant du noeud parent.
- Si le document d’origine comporte plusieurs noeuds portant le même identifiant, une erreur est déclenchée car les identifiants ne peuvent pas être distingués.
Une fois les fichiers de configuration fusionnés, le document obtenu contient tous les noeuds des fichiers d’origine.
Types, objets et interfaces de configuration
Les sections suivantes fournissent des informations sur les types de configuration, les objets de configuration correspondants et les interfaces que vous pouvez utiliser pour travailler avec les objets :
Types et objets de configuration
Le tableau suivant présente chaque type de configuration et l’objet de configuration Commerce auquel il se rapporte.
address_formats.xmlcatalog_attributes.xmlconfig.php et env.phpcommunication.xmleav_attributes.xmlemail_templates.xmlesconfig.xmlextension_attributes.xmlmenu.xmlmodule.xmlproduct_options.xmlqueue_consumer.xmlqueue_publisher.xmlqueue_topology.xmlresources.xmlsearch_engine.xmlsearch_request.xmlsections.xmlsystem.xmlvalidation.xmlview.xmlwebapi_async.xmlzip_codes.xmlInterfaces de configuration
Vous pouvez interagir avec les fichiers de configuration à l’aide d’interfaces sous Magento\Framework\Config.
Vous pouvez utiliser ces interfaces si vous créez un type de configuration.
Magento\Framework\Config fournit les interfaces suivantes :
- Framework\Config\ConverterInterface, qui convertit le fichier XML en une représentation de tableau en mémoire des configurations.
- Framework\Config\DataInterface, qui récupère les données de configuration dans une portée spécifiée.
- Framework\Config\FileResolverInterface, qui identifie l'emplacement des fichiers à lire par Magento\Framework\Config\ReaderInterface.
- Framework\Config\ReaderInterface, qui lit les données de configuration du stockage et sélectionne le stockage à partir duquel il lit.
En d’autres termes, le système de fichiers, la base de données et les autres espaces de stockage fusionnent les fichiers de configuration selon les règles de fusion et valident les fichiers de configuration avec les schémas de validation.
- Framework\Config\SchemaLocatorInterface, qui localise le schéma XSD.
- Framework\Config\ScopeListInterface, qui renvoie une liste de portées.
- Framework\Config\ValidationStateInterface, qui récupère l’état de validation.