Liste des événements Magento 2 et comment les utiliser

Dans cet article, nous allons vous montrer comment utiliser les événements dans Magento 2. Mais nous devons d'abord comprendre les événements et les observateurs . L'implémentation des événements et des observateurs dans Magento 2 est basée sur le modèle de publication-abonnement. À l'aide d'événements et d'observateurs, vous pouvez exécuter votre code personnalisé en réponse à un événement Magento spécifique ou même à un événement personnalisé.

Qu'est-ce que les événements dans Magento ?

Les événements sont distribués par les modules lorsque certaines actions sont déclenchées. En plus de ses propres événements, Magento vous permet de créer vos propres événements qui peuvent être dispatchés dans votre code. Lorsqu'un événement est distribué, il peut transmettre des données à tous les observateurs configurés pour surveiller cet événement.

Qu'est-ce que les observateurs dans Magento ?

Les observateurs sont un certain type de classe Magento qui peut influencer le comportement général, les performances ou modifier la logique métier. Les observateurs sont exécutés chaque fois que l'événement qu'ils sont configurés pour surveiller est envoyé par le gestionnaire d'événements.

Maintenant que nous comprenons les terminologies, mettons-les en pratique !

1. Créez le fichier event.xml

Vous pouvez créer un fichier event.xml pour différents domaines :

• Zone globale : app/code/Simi/HelloWorld/etc/events.xml
• Zone frontale : app/code/Simi/HelloWorld/etc/frontend/events.xml
• Zone d'administration : 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="mon_module_event_before">
        <observer name="monNomObservateur" instance="MonEntreprise\MonModule\Observateur\MonObservateur" />
    </événement>
    <event name="mon_module_event_after">
        <observer name="myObserverName" instance="MonEntreprise\MonModule\Observer\AnotherObserver" />
    </événement>
</config>

2. Créer une classe Observer

Pour créer un observateur, vous devez placer votre fichier de classe sous votre répertoire <module-root>/Observer . Votre classe d'observateur doit implémenter Magento\Framework\Event\ObserverInterface et définir sa fonction d' exécution .

Vous trouverez ci-dessous un exemple de la structure de base de la classe d'observateur :

 espace de noms MyCompany\MyModule\Observer ;

utilisez Magento\Framework\Event\ObserverInterface ;

la classe MyObserver implémente ObserverInterface
{
  fonction publique __construct()
  {
    // Code d'initialisation de l'observateur...
    // Vous pouvez utiliser l'injection de dépendances pour obtenir n'importe quelle classe dont cet observateur peut avoir besoin.
  }

  fonction publique execute(\Magento\Framework\Event\Observer $observer)
  {
    // Code d'exécution de l'observateur...
  }
}

L'une des fonctionnalités puissantes des observateurs est qu'ils sont capables d'utiliser les paramètres transmis à l'événement lorsqu'il a été envoyé.

Voici un exemple d'un observateur obtenant des données transmises lors de la distribution de l'événement :

 espace de noms MyCompany\MyModule\Observer ;

utilisez Magento\Framework\Event\ObserverInterface ;

classe AnotherObserver implémente ObserverInterface
{
  fonction publique __construct()
  {
    // Code d'initialisation de l'observateur...
    // Vous pouvez utiliser l'injection de dépendances pour obtenir n'importe quelle classe dont cet observateur peut avoir besoin.
  }

  fonction publique execute(\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Code d'exécution d'observateur supplémentaire...
  }
}

Abonnement aux événements

Les observateurs peuvent être configurés pour surveiller certains événements dans le fichier events.xml.

L'élément xml observer a les propriétés suivantes :

• name (obligatoire) – Le nom de l'observateur pour la définition d'événement.
• instance (requis) – Le nom de classe complet de l'observateur.
• désactivé – Détermine si cet observateur est actif ou non. La valeur par défaut est faux.
• partagé – Détermine le mode de vie de la classe. La valeur par défaut est true.

Vous trouverez ci-dessous un exemple de la façon d'affecter des observateurs pour surveiller certains événements :

 <?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="mon_module_event_before">
        <observer name="monNomObservateur" instance="MonEntreprise\MonModule\Observateur\MonObservateur" />
    </événement>
    <event name="mon_module_event_after">
        <observer name="myObserverName" instance="MonEntreprise\MonModule\Observer\AnotherObserver" />
    </événement>
</config>

Notez que les noms d'observateur doivent être uniques par définition d'événement. Vous ne pouvez pas avoir deux observateurs portant le même nom dans la même définition d'événement pour éviter un remplacement.

3. Événement d'expédition

Les événements peuvent être distribués à l'aide de la classe Magento\Framework\Event\Manager . Cette classe peut être obtenue par injection de dépendance en définissant la dépendance dans votre constructeur.

Pour envoyer un événement, appelez la fonction dispatch de la classe du gestionnaire d'événements et fournissez-lui le nom de l'événement que vous souhaitez envoyer ainsi qu'un tableau de données que vous souhaitez fournir aux observateurs.

L'exemple suivant vous montre comment envoyer un événement avec et sans tableau de données.

 espace de noms MaSociété\MonModule ;

utilisez Magento\Framework\Event\ManagerInterface comme EventManager ;

classe MaClasse
{
  /**
   * @var Gestionnaire d'événements
   */
  privé $eventManager ;

  fonction publique __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager ;
  }

  fonction publique quelque chose()
  {
    $eventData = null ;
    // Coder...
    $this->eventManager->dispatch('my_module_event_before');
    // Plus de code qui définit $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Liste des événements Magento 2

See also:

Comment activer le mode développeur dans Magento 2

Comment obtenir l'URL de l'image du produit dans Magento 2