Cursos Magento

Como criar um módulo para Magento 2

,

23 de janeiro de 2018

Neste artigo veremos um passo a passo de como criar um módulo para Magento 2 e conhecer um pouco da nova estrutura de módulos da versão 2. Este post também servirá como base para outros artigos relacionados ao desenvolvimento para Magento 2.

Se você está interessado em como criar módulos e desenvolver para Magento 1, veja a lista de cursos Magento disponíveis.

Criando os arquivos básicos de um módulo Magento 2

Diferente do Magento 1, todos os arquivos e pastas de um módulo ficam dentro de um único diretório.  Portanto, não é mais necessário adicionarmos arquivos em lugares separados para ativar um módulo. Mesmo os arquivos de JavaScript e CSS agora ficam todos dentro da pasta do módulo.

Nosso módulo de exemplo se chamará Magenteiro_BaseModule. Vamos criar os seguintes arquivos:

Dica: Se você está usando uma IDE, configure ela para reconhecer os XSD’s do Magento 2. Isso ajudará você a entender e conhecer as opções disponíveis em alguns XML’s.

Com os arquivos criados já podemos ativar nosso módulo.

Verificando nosso módulo

Para ver se está tudo certo e se o Magento reconheceu nosso módulo, vá ao terminal na pasta do seu Magento e digite bin/magento module:status.

Note que nosso módulo aparecerá como desabilitado. Caso não apareça para você, limpe os caches do seu Magento com bin/magento cache:flush.

Ativando nosso módulo

Por fim, para ativar nosso módulo, digite bin/magento module:enable Magenteiro_BaseModule.

Ativando nosso módulo com bin/magento module:enable

Neste momento o Magento limpará os caches e ativará nosso novo módulo.

Pronto! Nosso módulo base está pronto e reconhecido pelo Magento. Agora podemos trabalhar nossas customizações e implementações nele.

Se desejar, informe seu nome e e-mail abaixo e receba o módulo em seu e-mail para usá-lo como referência no futuro.

O tal do composer.json no módulo para Magento 2

Como você notou, todos os módulos e temas do Magento 2 possuem um arquivo composer.json. Mesmo que você não pretenda distribuir sua extensão, ele é necessário para o bom funcionamento do seu pacote. Isso porque o Magento 2 possuí um gerenciador de componentes (Component Manager) que lê este arquivo durante a instalação, desinstalação, e atualização de um módulo, mesmo que este módulo não tenha sido instalado via composer.

Há uma série de convenções e padrões que devemos seguir ao criar nosso composer.json. Elas estão disponíveis neste link da documentação oficial, embora todos os campos também são explicados de forma detalhada na documentação de esquema do próprio composer.

No entanto, vou comentar duas que são importantes e que foram usadas no nosso módulo de exemplo.

O parâmetro name deve seguir o nome que seria (ou será) usado quando você distribuir o seu módulo no Packagist (repositório oficial do composer) ou mesmo no Magento Marketplace. Por padrão, usa-se o nomeDoFornecedor/NomeDoModulo, mas você pode dar outro nome caso queira ser encontrado de forma diferente na hora de distribuir seu módulo.

O nome do nosso módulo e como o Magento irá reconhecê-lo é identificado no registration.php, que é carregado automaticamente na inicialização do nosso módulo.

 

O type especifica que tipo de componente é este pacote. Ele pode ser:

  • magento2-module usado em módulos em geral
  • magento2-theme para temas
  • magento2-language para pacotes de tradução
  • magento2-component para outras coisas que não se encaixem nos tipos acima

 

 

Gostou deste artigo? Comente, compartilhe, e se inscreva para receber notificações sobre conteúdo Magento todas as semanas.

 

 

Imagem principal por Nadine Shabaana.

Ricardo Martins

Desenvolvedor web há mais de 15 anos, desde 2011 totalmente especializado em Magento, ajudo na criação de conteúdo, e cursos online sobre Magento - hoje com mais de 7000 alunos de 97 países - e criador do módulo PagSeguro Transparente para Magento, usado em mais de 12 mil lojas.

Últimos posts por Ricardo Martins (exibir todos)

Assuntos: | |
Comentários