Elenco eventi Magento 2 e come utilizzarli

In questo post ti mostreremo come usare gli eventi in Magento 2. Ma prima dobbiamo capire gli eventi e gli osservatori . L'implementazione di eventi e osservatori in Magento 2 si basa sul modello di pubblicazione-sottoscrizione. Utilizzando eventi e osservatori, puoi eseguire il tuo codice personalizzato in risposta a uno specifico evento Magento o anche a un evento personalizzato.

Cosa sono gli eventi a Magento?

Gli eventi vengono inviati dai moduli quando vengono attivate determinate azioni. Oltre ai propri eventi, Magento ti consente di creare i tuoi eventi che possono essere inviati nel tuo codice. Quando un evento viene inviato, può passare i dati a qualsiasi osservatore configurato per guardare quell'evento.

Cosa sono gli osservatori in Magento?

Gli osservatori sono un certo tipo di classe Magento che può influenzare il comportamento generale, le prestazioni o modificare la logica aziendale. Gli osservatori vengono eseguiti ogni volta che l'evento che sono configurati per guardare viene inviato dal gestore eventi.

Ora che comprendiamo le terminologie, mettiamole in uso!

1. Crea il file event.xml

Puoi creare un file event.xml per diverse aree:

• Area globale: app/codice/Simi/HelloWorld/etc/events.xml
• Area frontend: app/codice/Simi/HelloWorld/etc/frontend/events.xml
• Area di amministrazione: app/code/Simi/HelloWorld/etc/adminhtml/events.xml

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

2. Crea la classe Osservatore

Per creare un osservatore, devi posizionare il tuo file di classe nella directory <module-root>/Observer . La tua classe osservatore dovrebbe implementare Magento\Framework\Event\ObserverInterface e definire la sua funzione di esecuzione .

Di seguito è riportato un esempio della struttura della classe dell'osservatore di base:

 spazio dei nomi MyCompany\MyModule\Observer;

usa Magento\Framework\Event\ObserverInterface;

classe MyObserver implementa ObserverInterface
{
  funzione pubblica __costruzione()
  {
    // Codice di inizializzazione dell'osservatore...
    // Puoi usare l'iniezione di dipendenza per ottenere qualsiasi classe di cui questo osservatore potrebbe aver bisogno.
  }

  funzione pubblica esegui(\Magento\Framework\Event\Observer $observer)
  {
    // Codice di esecuzione dell'osservatore...
  }
}

Una delle potenti caratteristiche degli osservatori è che sono in grado di utilizzare i parametri passati all'evento quando è stato inviato.

Ecco un esempio di un osservatore che ottiene i dati passati quando l'evento è stato inviato:

 spazio dei nomi MyCompany\MyModule\Observer;

usa Magento\Framework\Event\ObserverInterface;

classe AnotherObserver implementa ObserverInterface
{
  funzione pubblica __costruzione()
  {
    // Codice di inizializzazione dell'osservatore...
    // Puoi usare l'iniezione di dipendenza per ottenere qualsiasi classe di cui questo osservatore potrebbe aver bisogno.
  }

  funzione pubblica esegui(\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $osservatore->getData('myEventData');
    // Codice di esecuzione dell'osservatore aggiuntivo...
  }
}

Iscrizione agli eventi

Gli osservatori possono essere configurati per guardare determinati eventi nel file events.xml.

L'elemento xml dell'osservatore ha le seguenti proprietà:

• name (obbligatorio) – Il nome dell'osservatore per la definizione dell'evento.
• istanza (obbligatorio) – Il nome di classe completo dell'osservatore.
• disabilitato : determina se questo osservatore è attivo o meno. Il valore predefinito è falso.
• condiviso – Determina lo stile di vita della classe. L'impostazione predefinita è vera.

Di seguito è riportato un esempio di come assegnare osservatori per guardare determinati eventi:

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

Si noti che i nomi degli osservatori devono essere univoci per definizione di evento. Non puoi avere due osservatori con lo stesso nome nella stessa definizione di evento per evitare un override.

3. Evento di spedizione

Gli eventi possono essere inviati utilizzando la classe Magento\Framework\Event\Manager . Questa classe può essere ottenuta tramite l'inserimento delle dipendenze definendo la dipendenza nel costruttore.

Per inviare un evento, chiama la funzione di invio della classe del gestore eventi e forniscigli il nome dell'evento che desideri inviare insieme a una matrice di dati che desideri fornire agli osservatori.

L'esempio seguente mostra come inviare un evento con e senza una matrice di dati.

 spazio dei nomi MyCompany\MyModule;

usa Magento\Framework\Event\ManagerInterface come EventManager;

classe MyClass
{
  /**
   * @var EventManager
   */
  privato $eventManager;

  funzione pubblica __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  funzione pubblica qualcosa ()
  {
    $dati evento = nullo;
    // Codice...
    $this->eventManager->dispatch('my_module_event_before');
    // Altro codice che imposta $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Elenco eventi Magento 2

See also:

Come abilitare la modalità sviluppatore in Magento 2

Come ottenere l'URL dell'immagine del prodotto in Magento 2