Gestion des extensions tierces
Le code qui étend ou personnalise le comportement d’Adobe Commerce est appelé extension. Vous pouvez éventuellement regrouper et distribuer des extensions sur Commerce Marketplace ou sur un autre système de distribution d’extensions.
Les extensions incluent :
- Modules (extension des fonctionnalités d’Adobe Commerce)
- Thèmes (modifier l’aspect de votre storefront et de votre administrateur)
- Packages de langue (localiser le storefront et l’administrateur)
Cette rubrique explique comment utiliser l’interface de ligne de commande pour gérer les extensions tierces que vous achetez auprès de Commerce Marketplace pour les projets On-premise. Pour les projets d’infrastructure cloud, voir Gestion des extensions.
Vous pouvez utiliser la même procédure pour installer l’extension any ; tout ce dont vous avez besoin est le nom et la version du compositeur de l’extension. Pour le trouver, ouvrez le fichier composer.json
de l’extension et notez les valeurs de "name"
et "version"
.
Installer
Avant l’installation, vous pouvez :
-
Sauvegardez votre base de données.
-
Activez le mode de maintenance :
code language-bash bin/magento maintenance:enable
Pour installer une extension, vous devez :
-
Obtenez une extension du Commerce Marketplace ou d’un autre développeur d’extensions.
-
Si vous installez une extension à partir de Commerce Marketplace, assurez-vous que le référentiel
repo.magento.com
existe dans votre fichiercomposer.json
:code language-bash "repositories": [ { "type": "composer", "url": "https://repo.magento.com/" } ]
-
Obtenez le nom et la version du compositeur de l’extension.
-
Mettez à jour le fichier
composer.json
dans votre projet avec le nom et la version de l’extension. -
Vérifiez que l’extension est installée correctement.
-
Activez et configurez l’extension.
Obtenir des informations sur l’extension
Si vous connaissez déjà le nom et la version du compositeur de l’extension, ignorez cette étape et continuez avec Mettre à jour votre fichier composer.json
.
Pour obtenir le nom et la version du compositeur de l’extension à partir du Commerce Marketplace :
-
Connectez-vous à Commerce Marketplace avec le nom d'utilisateur et le mot de passe que vous avez utilisés pour acheter l'extension.
-
Dans le coin supérieur droit, cliquez sur Votre nom > Mon profil.
-
Cliquez sur Mes achats.
-
Recherchez l’extension à installer et notez le nom et la version du composant.
composer.json
de l’extension.Mettre à jour les dépendances du compositeur
Ajoutez le nom et la version de l’extension à votre fichier composer.json
:
-
Accédez au répertoire du projet et mettez à jour le fichier
composer.json
.code language-bash composer require <component-name>:<version>
Par exemple,
code language-bash composer require j2t/module-payplug:2.0.2
-
Saisissez vos clés d’authentification. Votre clé publique est votre nom d'utilisateur ; votre clé privée est votre mot de passe.
-
Attendez que le compositeur ait terminé la mise à jour des dépendances de votre projet et vérifiez qu’il n’y a aucune erreur :
code language-none Updating dependencies (including require-dev) Package operations: 1 install, 0 updates, 0 removals - Installing j2t/module-payplug (2.0.2): Downloading (100%) Writing lock file Generating autoload files
Vérification de l’installation
Pour vérifier que l’extension est installée correctement, exécutez la commande suivante :
bin/magento module:status J2t_Payplug
Par défaut, l’extension est probablement désactivée :
Module is disabled
Le nom de l’extension est au format <VendorName>_<ComponentName>
; il s’agit d’un format différent du nom du compositeur. Utilisez ce format pour activer l’extension. Si vous n’êtes pas sûr du nom de l’extension, exécutez :
bin/magento module:status
Et recherchez l’extension sous « Liste des modules désactivés ».
Activer
Certaines extensions ne fonctionnent pas correctement, sauf si vous effacez d’abord les fichiers d’affichage statique générés. Utilisez l’option --clear-static-content
pour effacer les fichiers d’affichage statiques lorsque vous activez une extension.
-
Activez l’extension et effacez les fichiers d’affichage statique :
code language-bash bin/magento module:enable J2t_Payplug --clear-static-content
La sortie suivante devrait s’afficher :
code language-none The following modules have been enabled: - J2t_Payplug To make sure that the enabled modules are properly registered, run 'setup:upgrade'. Cache cleared successfully. Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes. Generated static view files cleared successfully.
-
Enregistrez l’extension :
code language-bash bin/magento setup:upgrade
-
Recompiler votre projet : en mode Production, vous pouvez recevoir un message indiquant « Veuillez réexécuter la commande de compilation Magento ». L’application ne vous invite pas à exécuter la commande compiler en mode Développeur.
code language-bash bin/magento setup:di:compile
-
Vérifiez que l’extension est activée :
code language-bash bin/magento module:status J2t_Payplug
Vous devriez voir la sortie vérifiant que l’extension n’est plus désactivée :
code language-none Module is enabled
-
Nettoyez le cache :
code language-bash bin/magento cache:clean
-
Configurez l’extension dans Admin selon vos besoins.
bin/magento cache:flush
.Mise à niveau
Pour mettre à jour ou mettre à niveau un module ou une extension :
-
Téléchargez le fichier mis à jour à partir de Marketplace ou d’un autre développeur d’extensions. Notez le nom et la version du module.
-
Exportez le contenu vers le répertoire racine de votre application.
-
S’il existe un package de compositeur pour le module , exécutez l’une des opérations suivantes.
Mettre à jour par nom de module :
code language-bash composer update vendor/module-name
Mise à jour par version :
code language-bash composer require vendor/module-name ^x.x.x
-
Exécutez les commandes suivantes pour mettre à niveau, déployer et nettoyer le cache.
code language-bash bin/magento setup:upgrade --keep-generated
code language-bash bin/magento setup:static-content:deploy
code language-bash bin/magento cache:clean
Désinstaller
Vous devez contacter le fournisseur de l’extension pour obtenir des instructions sur la suppression d’une extension tierce. Les instructions doivent fournir les informations suivantes :
- Comment annuler les modifications de table de base de données
- Comment annuler les modifications apportées aux données de la base de données
- Les fichiers à supprimer ou à rétablir
Les instructions suivantes fournissent des informations générales sur la désinstallation des extensions tierces :
-
Supprimez l’extension de votre référentiel de projet Adobe Commerce.
-
Pour les extensions basées sur un compositeur, supprimez l’extension de votre fichier Adobe Commerce
composer.json
.code language-bash composer remove <component-name>
-
Pour les extensions non basées sur un compositeur, supprimez les fichiers physiques du référentiel de votre projet Adobe Commerce.
code language-bash rm -rf app/code/<vendor-name>/<component-name>
-
-
Si le fichier
config.php
est sous contrôle de code source dans votre référentiel de projet Adobe Commerce, supprimez l’extension du fichierconfig.php
. -
Testez votre base de données locale pour vous assurer que les instructions fournies par le fournisseur fonctionnent comme prévu.
-
Vérifiez que l’extension est correctement désactivée et que votre site web fonctionne comme prévu sur votre environnement d’évaluation.
-
Déployez les modifications dans votre environnement de production.