DocumentaçãoCommerceGuia do Commerce na infraestrutura em nuvem

Gerenciar extensões

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Administrador
  • Desenvolvedor

É possível estender os recursos do aplicativo Adobe Commerce adicionando uma extensão do Commerce Marketplace. Por exemplo, você pode adicionar um tema para alterar a aparência da loja ou adicionar um pacote de idioma para localizar sua loja e o Administrador.

NOTE
Para evitar problemas de instalação, todas as compras do Marketplace devem ser concluídas usando a mesma conta (MAGEID) que é proprietária do projeto de nuvem.

Nome do compositor de uma extensão

Embora esta seção discuta como obter o nome e a versão de uma extensão do Composer do Commerce Marketplace, você pode encontrar o nome e a versão do módulo any no arquivo do Composer do módulo. Abra o arquivo composer.json em um editor de texto e anote os valores "name" e "version".

Para obter o nome do Compositor de um módulo do Commerce Marketplace:

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

  2. No canto superior direito, clique no seu nome de usuário e selecione Meu perfil.

    Acessar sua conta do Marketplace

  3. Na página Minha conta, clique em Minhas compras.

    Histórico de compras do Marketplace

  4. Na página Minhas compras, selecione um módulo que você adquiriu e clique em Detalhes Técnicos.

  5. Clique em Copiar para copiar o Component name para a área de transferência.

  6. Abra um editor de texto e cole o nome do componente e anexe um caractere de dois pontos (:).

  7. Em Detalhes Técnicos, clique em Copiar para copiar o Component version para a área de transferência.

  8. No editor de texto, anexe o número de versão ao nome do componente após os dois pontos. Por exemplo:

    code language-text 
    extension-name/magento2:1.0.1

Instalar uma extensão

A Adobe recomenda trabalhar em uma ramificação de desenvolvimento ao adicionar uma extensão à implementação. Ao instalar uma extensão, o nome da extensão (<VendorName>_<ComponentName>) é inserido automaticamente no arquivo app/etc/config.php. Não há necessidade de editar o arquivo diretamente.

Para instalar uma extensão:

  1. Na estação de trabalho local, altere para o diretório do projeto.

  2. Criar ou dar baixa em uma ramificação de desenvolvimento. Consulte ramificação.

  3. Usando o nome e a versão do Composer, adicione a extensão à seção require do arquivo composer.json.

    code language-bash 
    composer require <extension-name>:<version> --no-update

  4. Atualize as dependências do projeto.

    code language-bash 
    composer update

  5. Adicionar, confirmar e enviar alterações de código.

    code language-bash 
    git add -A
    code language-bash 
    git commit -m "Install <extension-name>"
    code language-bash 
    git push origin <branch-name>
    note warning
    WARNING
    Ao instalar uma extensão, você deve incluir o arquivo composer.lock ao enviar alterações de código para o ambiente remoto. O comando composer install lê o arquivo composer.lock para habilitar as dependências definidas no ambiente remoto.

  6. Após a conclusão da build e implantação, use um SSH para fazer logon no ambiente remoto e verificar a extensão instalada.

    code language-bash 
    bin/magento module:status <extension-name>

    Um nome de extensão usa o formato: <VendorName>_<ComponentName>.

    Exemplo de resposta:

    code language-none 
    Module is enabled

    Se você encontrar erros de implantação, consulte falha de implantação de extensão.

Gerenciar extensões

Ao adicionar uma extensão usando o Composer, o processo de implantação ativa automaticamente a extensão. Se você já tiver a extensão instalada, poderá ativar ou desativar a extensão usando a CLI. Ao gerenciar extensões, use o formato: <VendorName>_<ComponentName>

Nunca ative ou desative uma extensão enquanto estiver conectado em ambientes remotos.

Para ativar ou desativar uma extensão:

  1. Na estação de trabalho local, altere para o diretório do projeto.

  2. Ative ou desative um módulo. O comando module atualiza o arquivo config.php com o status solicitado do módulo.

    Habilite um módulo.

    code language-bash 
    bin/magento module:enable <module-name>

    Desative um módulo.

    code language-bash 
    bin/magento module:disable <module-name>

  3. Se você habilitou um módulo, use ece-tools para atualizar a configuração.

    code language-bash 
    ./vendor/bin/ece-tools module:refresh

  4. Verifique o status de um módulo.

    code language-bash 
    bin/magento module:status <module-name>

  5. Adicionar, confirmar e enviar alterações de código.

    code language-bash 
    git add -A
    code language-bash 
    git commit -m "Disable <extension-name>"
    code language-bash 
    git push origin <branch-names>

Atualizar uma extensão

Antes de continuar, é necessário o nome e a versão do Composer para a extensão. Além disso, confirme se a extensão é compatível com o projeto e a versão do Adobe Commerce. Em particular, verifique a versão necessária do PHP antes de começar.

Para atualizar uma extensão:

  1. Na estação de trabalho local, altere para o diretório do projeto.

  2. Criar ou dar baixa em uma ramificação de desenvolvimento. Consulte ramificação.

  3. Abra o arquivo composer.json em um editor de texto.

  4. Localize sua extensão e atualize a versão.

  5. Salve as alterações e saia do editor de texto.

  6. Atualize as dependências do projeto.

    code language-bash 
    composer update

  7. Adicionar, confirmar e enviar por push as alterações de código.

    code language-bash 
    git add -A
    code language-bash 
    git commit -m "Update <extension-name>"
    code language-bash 
    git push origin <branch-names>

Se você encontrar erros, consulte Recuperar de falha de componente. Para saber mais sobre o uso de extensões com o Adobe Commerce, consulte Extensões no Guia do Administrador.

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26