DocumentaçãoCommerceGuia de instalação

Gerenciar extensões de terceiros

Last update: Mon Nov 04 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Experiente
  • Administrador
  • Desenvolvedor

O código que estende ou personaliza o comportamento do Adobe Commerce é chamado de extensão. Opcionalmente, é possível empacotar e distribuir extensões no Commerce Marketplace ou em outro sistema de distribuição de extensões.

As extensões incluem:

  • Módulos (estenda os recursos do Adobe Commerce)
  • Temas (altere a aparência da loja e do administrador)
  • Pacotes de idioma (localize a loja e o Administrador)

Este tópico explica como usar a interface de linha de comando para gerenciar extensões de terceiros que você compra do Commerce Marketplace para projetos do no local. Para projetos de infraestrutura em nuvem, consulte Gerenciar extensões.

Você pode usar o mesmo procedimento para instalar a extensão any. Tudo o que você precisa é o nome e a versão do Compositor da extensão. Para encontrá-lo, abra o arquivo composer.json da extensão e anote os valores de "name" e "version".

Instalar

Antes da instalação, talvez você queira:

  1. Faça backup do banco de dados.

  2. Habilitar modo de manutenção:

    code language-bash 
    bin/magento maintenance:enable

Para instalar uma extensão, você deve:

  1. Obtenha uma extensão do Commerce Marketplace ou de outro desenvolvedor de extensão.

  2. Se você instalar uma extensão do Commerce Marketplace, verifique se o repositório repo.magento.com existe no arquivo composer.json:

    code language-bash 
    "repositories": [
    {
        "type": "composer",
        "url": "https://repo.magento.com/"
    }
]

  3. Obtenha o nome e a versão do Compositor da extensão.

  4. Atualize o arquivo composer.json em seu projeto com o nome e a versão da extensão.

  5. Verifique se a extensão foi instalada corretamente.

  6. Ative e configure a extensão.

Obter informações de extensão

Se você já sabe o nome e a versão do Composer da extensão, ignore esta etapa e continue com Atualize seu arquivo composer.json.

Para obter o nome e a versão do Compositor da extensão do Commerce Marketplace:

  1. Faça logon em Commerce Marketplace com o nome de usuário e a senha que você usou para comprar a extensão.

  2. No canto superior direito, clique em Seu nome > Meu perfil.

    Acessar sua conta do Marketplace

  3. Clique em Minhas compras.

    Histórico de compras do Marketplace

  4. Encontre a extensão que deseja instalar e anote o nome e a versão do componente.

    Os detalhes técnicos mostram o nome do Compositor da extensão

TIP
Como alternativa, você pode encontrar o nome e a versão do Composer da extensão any (seja na compra no Commerce Marketplace ou em outro lugar) no arquivo composer.json da extensão.

Atualizar dependências do Composer

Adicione o nome e a versão da extensão ao arquivo composer.json:

  1. Navegue até o diretório do projeto e atualize o arquivo composer.json.

    code language-bash 
    composer require <component-name>:<version>

    Por exemplo,

    code language-bash 
    composer require j2t/module-payplug:2.0.2

  2. Insira suas chaves de autenticação. Sua chave pública é seu nome de usuário; sua chave privada é sua senha.

  3. Aguarde até que o Composer conclua a atualização das dependências do projeto e verifique se não há erros:

    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

Verificar instalação

Para verificar se a extensão foi instalada corretamente, execute o seguinte comando:

bin/magento module:status J2t_Payplug

Por padrão, a extensão provavelmente está desativada:

Module is disabled

O nome da extensão está no formato <VendorName>_<ComponentName>; esse é um formato diferente do nome do Compositor. Use esse formato para habilitar a extensão. Se não tiver certeza do nome da extensão, execute:

bin/magento module:status

E procure a extensão em "Lista de módulos desativados".

Ativar

Algumas extensões não funcionam corretamente, a menos que você limpe primeiro os arquivos de exibição estáticos gerados. Use a opção --clear-static-content para limpar arquivos de exibição estáticos quando estiver habilitando uma extensão.

  1. Habilite a extensão e limpe os arquivos de exibição estáticos:

    code language-bash 
    bin/magento module:enable J2t_Payplug --clear-static-content

    Você deve ver a seguinte saída:

    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.

  2. Registre a extensão:

    code language-bash 
    bin/magento setup:upgrade

  3. Recompile o projeto: no modo de Produção, você pode receber uma mensagem para "Execute novamente o comando Magento compile". O aplicativo não solicita que você execute o comando compile no modo de Desenvolvedor.

    code language-bash 
    bin/magento setup:di:compile

  4. Verifique se a extensão está ativada:

    code language-bash 
    bin/magento module:status J2t_Payplug

    Você deve ver a saída verificando se a extensão não está mais desativada:

    code language-none 
    Module is enabled

  5. Limpe o cache:

    code language-bash 
    bin/magento cache:clean

  6. Configure a extensão no Admin conforme necessário.

TIP
Se você encontrar erros ao carregar a loja em um navegador, use o seguinte comando para limpar o cache: bin/magento cache:flush.

Atualizar

Para atualizar ou atualizar um módulo ou uma extensão:

  1. Baixe o arquivo atualizado do Marketplace ou de outro desenvolvedor de extensão. Anote o nome e a versão do módulo.

  2. Exporte o conteúdo para o diretório raiz do aplicativo.

  3. Se existir um pacote do Composer para o módulo, execute um dos procedimentos a seguir.

    Atualizar por nome de módulo:

    code language-bash 
    composer update vendor/module-name

    Atualizar por versão:

    code language-bash 
    composer require vendor/module-name ^x.x.x

  4. Execute os seguintes comandos para atualizar, implantar e limpar o 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

Desinstalar

Você deve entrar em contato com o fornecedor da extensão para obter instruções sobre como remover uma extensão de terceiros. As instruções devem fornecer as seguintes informações:

  • Como reverter alterações na tabela do banco de dados
  • Como reverter alterações de dados do banco de dados
  • Quais arquivos devem ser removidos ou revertidos
CAUTION
Execute as etapas de desinstalação em um ambiente de não produção first e teste completamente antes de implantar em seu ambiente de produção.

As instruções a seguir fornecem informações gerais para a desinstalação de extensões de terceiros:

  1. Remova a extensão do repositório de projetos do Adobe Commerce.

    • Para extensões baseadas no Composer, remova a extensão do arquivo Adobe Commerce composer.json.

      code language-bash 
      composer remove <component-name>

    • Para extensões não baseadas no Composer, remova os arquivos físicos do repositório do projeto do Adobe Commerce.

      code language-bash 
      rm -rf app/code/<vendor-name>/<component-name>

  2. Se o arquivo config.php estiver sob controle do código-fonte no repositório de projetos do Adobe Commerce, remova a extensão do arquivo config.php.

  3. Teste o banco de dados local para garantir que as instruções fornecidas pelo fornecedor funcionem conforme esperado.

  4. Verifique se a extensão está desativada corretamente e se o site funciona conforme esperado em seu ambiente de preparo.

  5. Implante as alterações no ambiente de produção.

recommendation-more-help
0f8e7db5-0e9c-4002-a5b8-a0088077d995