Lista de eventos de Magento 2 y cómo usarlos

En esta publicación, le mostraremos cómo usar eventos en Magento 2. Pero primero debemos entender acerca de los eventos y los observadores . La implementación de eventos y observadores en Magento 2 se basa en el patrón de publicación-suscripción. Usando eventos y observadores, puede ejecutar su código personalizado en respuesta a un evento específico de Magento o incluso a un evento personalizado.

¿Qué son los eventos en Magento?

Los eventos son enviados por módulos cuando se activan ciertas acciones. Además de sus propios eventos, Magento le permite crear sus propios eventos que pueden enviarse en su código. Cuando se envía un evento, puede pasar datos a cualquier observador configurado para ver ese evento.

¿Qué son los observadores en Magento?

Los observadores son un cierto tipo de clase de Magento que pueden influir en el comportamiento general, el rendimiento o cambiar la lógica comercial. Los observadores se ejecutan cada vez que el administrador de eventos envía el evento que están configurados para observar.

Ahora que entendemos las terminologías, ¡pongámoslas en uso!

1. Crear archivo event.xml

Puede crear un archivo event.xml para diferentes áreas:

• Área global: aplicación/código/Simi/HelloWorld/etc/events.xml
• Área de interfaz: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Área de administración: app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml versión="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <nombre del evento="mi_modulo_evento_antes">
        <observer name="miObservadorNombre" instancia="MiEmpresa\MiMódulo\Observador\MiObservador" />
    </evento>
    <nombre del evento="mi_módulo_evento_después">
        <observer name="miObservadorNombre" instancia="MiEmpresa\MiMódulo\Observador\OtroObservador" />
    </evento>
</config>

2. Crear clase de observador

Para crear un observador, debe colocar su archivo de clase en su directorio <module-root>/Observer . Su clase de observador debe implementar Magento\Framework\Event\ObserverInterface y definir su función de ejecución .

A continuación se muestra un ejemplo de la estructura básica de clases de observador:

 espacio de nombres MiEmpresa\MiMódulo\Observador;

use Magento\Framework\Event\ObserverInterface;

clase MyObserver implementa ObserverInterface
{
  función pública __construct()
  {
    // Código de inicialización del observador...
    // Puede usar la inyección de dependencia para obtener cualquier clase que este observador pueda necesitar.
  }

  función pública ejecutar (\Magento\Framework\Event\Observer $observer)
  {
    // Código de ejecución del observador...
  }
}

Una de las características poderosas de los observadores es que pueden usar parámetros pasados ​​al evento cuando se envió.

Aquí hay un ejemplo de un observador que obtiene datos pasados ​​cuando se envió el evento:

 espacio de nombres MiEmpresa\MiMódulo\Observador;

use Magento\Framework\Event\ObserverInterface;

clase AnotherObserver implementa ObserverInterface
{
  función pública __construct()
  {
    // Código de inicialización del observador...
    // Puede usar la inyección de dependencia para obtener cualquier clase que este observador pueda necesitar.
  }

  función pública ejecutar (\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Código adicional de ejecución del observador...
  }
}

Suscripción a eventos

Los observadores se pueden configurar para ver ciertos eventos en el archivo events.xml.

El elemento xml observador tiene las siguientes propiedades:

• nombre (obligatorio): el nombre del observador para la definición del evento.
• instancia (obligatorio): el nombre de clase completo del observador.
• disabled : determina si este observador está activo o no. El valor predeterminado es falso.
• compartida – Determina el estilo de vida de la clase. El valor predeterminado es verdadero.

A continuación se muestra un ejemplo de cómo asignar observadores para ver ciertos eventos:

 <?xml versión="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <nombre del evento="mi_modulo_evento_antes">
        <observer name="miObservadorNombre" instancia="MiEmpresa\MiMódulo\Observador\MiObservador" />
    </evento>
    <nombre del evento="mi_módulo_evento_después">
        <observer name="miNombreDeObservador" instancia="MiEmpresa\MiMódulo\Observador\OtroObservador" />
    </evento>
</config>

Tenga en cuenta que los nombres de los observadores deben ser únicos por definición de evento. No puede tener dos observadores con el mismo nombre en la misma definición de evento para evitar una anulación.

3. Evento de despacho

Los eventos se pueden distribuir mediante la clase Magento\Framework\Event\Manager . Esta clase se puede obtener a través de la inyección de dependencia definiendo la dependencia en su constructor.

Para enviar un evento, llame a la función de envío de la clase de administrador de eventos y proporcione el nombre del evento que desea enviar junto con una serie de datos que desea proporcionar a los observadores.

El siguiente ejemplo le muestra cómo enviar un evento con y sin una matriz de datos.

 espacio de nombres MiEmpresa\MiMódulo;

use Magento\Framework\Event\ManagerInterface como EventManager;

clase Mi Clase
{
  /**
   * @var EventManager
   */
  privado $gestor de eventos;

  función pública __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  función pública algo()
  {
    $eventData = nulo;
    // Código...
    $this->eventManager->dispatch('my_module_event_before');
    // Más código que establece $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Lista de eventos de Magento 2

See also:

Cómo habilitar el modo desarrollador en Magento 2

Cómo obtener la URL de la imagen del producto en Magento 2