Lista de evenimente Magento 2 și cum să le folosiți

În această postare, vă vom arăta cum să utilizați evenimentele în Magento 2. Dar mai întâi trebuie să înțelegem despre evenimente și observatori . Implementarea evenimentelor și observatorilor în Magento 2 se bazează pe modelul de publicare-abonare. Folosind evenimente și observatori, puteți rula codul personalizat ca răspuns la un anumit eveniment Magento sau chiar la un eveniment personalizat.

Ce sunt evenimentele în Magento?

Evenimentele sunt trimise de module atunci când anumite acțiuni sunt declanșate. Pe lângă propriile evenimente, Magento vă permite să vă creați propriile evenimente care pot fi trimise în codul dvs. Când un eveniment este trimis, acesta poate transmite date oricăror observatori configurați să urmărească acel eveniment.

Ce este observatorii în Magento?

Observatorii sunt un anumit tip de clasă Magento care poate influența comportamentul general, performanța sau poate schimba logica de afaceri. Observatorii sunt executați ori de câte ori evenimentul pe care sunt configurați să îl urmărească este expediat de managerul de evenimente.

Acum că înțelegem terminologiile, să le punem în uz!

1. Creați fișierul event.xml

Puteți crea fișier event.xml pentru diferite zone:

• Zona globală: app/code/Simi/HelloWorld/etc/events.xml
• Zona front-end: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Zona de administrare: 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" />
    </eveniment>
    <event name="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </eveniment>
</config>

2. Creați clasa Observer

Pentru a crea un observator, trebuie să plasați fișierul de clasă în directorul <module-root>/Observer . Clasa dvs. de observator ar trebui să implementeze Magento\Framework\Event\ObserverInterface și să-și definească funcția de execuție .

Mai jos este un exemplu de structura de bază a clasei de observator:

 namespace MyCompany\MyModule\Observer;

utilizați Magento\Framework\Event\ObserverInterface;

clasa MyObserver implementează ObserverInterface
{
  funcția publică __construct()
  {
    // Codul de inițializare a observatorului...
    // Puteți folosi injecția de dependență pentru a obține orice clasă pe care acest observator ar putea avea nevoie.
  }

  funcția publică execute(\Magento\Framework\Event\Observer $observator)
  {
    // Codul de execuție al observatorului...
  }
}

Una dintre caracteristicile puternice ale observatorilor este că sunt capabili să utilizeze parametrii trecuți în eveniment când acesta a fost expediat.

Iată un exemplu de observator care obține date transmise atunci când evenimentul a fost expediat:

 namespace MyCompany\MyModule\Observer;

utilizați Magento\Framework\Event\ObserverInterface;

clasa AnotherObserver implementează ObserverInterface
{
  funcția publică __construct()
  {
    // Codul de inițializare a observatorului...
    // Puteți folosi injecția de dependență pentru a obține orice clasă pe care acest observator ar putea avea nevoie.
  }

  funcția publică execute(\Magento\Framework\Event\Observer $observator)
  {
    $myEventData = $observator->getData('myEventData');
    // Cod suplimentar de execuție a observatorului...
  }
}

Abonarea la evenimente

Observatorii pot fi configurați să urmărească anumite evenimente din fișierul events.xml.

Elementul xml observator are următoarele proprietăți:

• nume (obligatoriu) – Numele observatorului pentru definiția evenimentului.
• instanță (obligatoriu) – Numele de clasă complet calificat al observatorului.
• disabled – Stabilește dacă acest observator este activ sau nu. Valoarea implicită este falsă.
• shared – Determină stilul de viață al clasei. Implicit este adevărat.

Mai jos este un exemplu despre cum să atribuiți observatori să urmărească anumite evenimente:

 <?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" />
    </eveniment>
    <event name="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </eveniment>
</config>

Rețineți că numele observatorilor trebuie să fie unice pentru definiția evenimentului. Nu puteți avea doi observatori cu același nume în aceeași definiție a evenimentului pentru a evita o modificare.

3. Eveniment de expediere

Evenimentele pot fi expediate folosind clasa Magento\Framework\Event\Manager . Această clasă poate fi obținută prin injectarea dependenței prin definirea dependenței în constructorul dumneavoastră.

Pentru a trimite un eveniment, apelați funcția de expediere a clasei de manager de evenimente și furnizați-i numele evenimentului pe care doriți să îl expediați împreună cu o serie de date pe care doriți să le furnizați observatorilor.

Următorul exemplu vă arată cum să trimiteți un eveniment cu și fără o serie de date.

 namespace MyCompany\MyModule;

utilizați Magento\Framework\Event\ManagerInterface ca EventManager;

clasa MyClass
{
  /**
   * @var EventManager
   */
  private $eventManager;

  funcția publică __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  funcție publică ceva ()
  {
    $eventData = null;
    // Cod...
    $this->eventManager->dispatch('my_module_event_before');
    // Mai mult cod care setează $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Lista de evenimente Magento 2

See also:

Cum să activați Modul Dezvoltator în Magento 2

Cum să obțineți adresa URL a imaginii produsului în Magento 2