Lista de eventos do Magento 2 e como usá-los

Neste post vamos mostrar como usar eventos no Magento 2. Mas primeiro precisamos entender sobre eventos e observadores . A implementação de eventos e observadores no Magento 2 é baseada no padrão de publicação-assinatura. Usando eventos e observadores, você pode executar seu código personalizado em resposta a um evento específico do Magento ou até mesmo a um evento personalizado.

O que são eventos no Magento?

Os eventos são despachados por módulos quando certas ações são acionadas. Além de seus próprios eventos, o Magento permite que você crie seus próprios eventos que podem ser despachados em seu código. Quando um evento é despachado, ele pode passar dados para qualquer observador configurado para assistir a esse evento.

O que são observadores no Magento?

Os observadores são um certo tipo de classe Magento que pode influenciar o comportamento geral, o desempenho ou alterar a lógica de negócios. Os observadores são executados sempre que o evento que eles estão configurados para observar é despachado pelo gerenciador de eventos.

Agora que entendemos as terminologias, vamos colocá-las em uso!

1. Crie o arquivo event.xml

Você pode criar o arquivo event.xml para diferentes áreas:

• Área global: app/code/Simi/HelloWorld/etc/events.xml
• Área de front-end: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Área de administração: app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </event>
    <event name="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </event>
</config>

2. Criar classe Observador

Para criar um observador, você deve colocar seu arquivo de classe no diretório <module-root>/Observer . Sua classe Observer deve implementar Magento\Framework\Event\ObserverInterface e definir sua função de execução .

Abaixo está um exemplo da estrutura básica de classe do observador:

 namespace MinhaEmpresa\MeuMódulo\Observador;

use Magento\Framework\Event\ObserverInterface;

classe MyObserver implementa ObserverInterface
{
  função pública __construct()
  {
    // Código de inicialização do observador...
    // Você pode usar injeção de dependência para obter qualquer classe que este observador possa precisar.
  }

  função pública execute(\Magento\Framework\Event\Observer $observer)
  {
    // Código de execução do observador...
  }
}

Um dos recursos poderosos dos observadores é que eles podem usar os parâmetros passados ​​para o evento quando ele foi despachado.

Aqui está um exemplo de um observador obtendo dados passados ​​quando o evento foi despachado:

 namespace MinhaEmpresa\MeuMódulo\Observador;

use Magento\Framework\Event\ObserverInterface;

classe AnotherObserver implementa ObserverInterface
{
  função pública __construct()
  {
    // Código de inicialização do observador...
    // Você pode usar injeção de dependência para obter qualquer classe que este observador possa precisar.
  }

  função pública execute(\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Código de execução do observador adicional...
  }
}

Inscrevendo-se em eventos

Os observadores podem ser configurados para observar determinados eventos no arquivo events.xml.

O elemento xml do observador tem as seguintes propriedades:

• name (obrigatório) – O nome do observador para a definição do evento.
• instância (obrigatório) – O nome de classe totalmente qualificado do observador.
• disabled – Determina se este observador está ativo ou não. O valor padrão é falso.
• compartilhado – Determina o estilo de vida da turma. O padrão é verdadeiro.

Abaixo está um exemplo de como atribuir observadores para assistir a determinados eventos:

 <?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </event>
    <event name="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </event>
</config>

Observe que os nomes dos observadores devem ser exclusivos por definição de evento. Você não pode ter dois observadores com o mesmo nome na mesma definição de evento para evitar uma substituição.

3. Evento de despacho

Os eventos podem ser despachados usando a classe Magento\Framework\Event\Manager . Essa classe pode ser obtida por meio de injeção de dependência definindo a dependência em seu construtor.

Para despachar um evento, chame a função dispatch da classe do gerenciador de eventos e forneça a ela o nome do evento que você deseja despachar junto com uma matriz de dados que deseja fornecer aos observadores.

O exemplo a seguir mostra como despachar um evento com e sem uma matriz de dados.

 namespace MinhaEmpresa\MeuMódulo;

use Magento\Framework\Event\ManagerInterface como EventManager;

classe MinhaClasse
{
  /**
   * @var EventManager
   */
  private $ eventManager;

  função pública __construct(EventManager $eventManager)
  {
    $this->gerenciador de eventos = $Gerenciador de eventos;
  }

  função pública algo()
  {
    $eventData = null;
    // Código...
    $this->eventManager->dispatch('my_module_event_before');
    // Mais código que define $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Lista de eventos do Magento 2

See also:

Como habilitar o modo de desenvolvedor no Magento 2

Como obter o URL da imagem do produto no Magento 2