Lista wydarzeń Magento 2 i jak z nich korzystać

W tym poście pokażemy, jak używać zdarzeń w Magento 2. Ale najpierw musimy zrozumieć zdarzenia i obserwatorów . Implementacja zdarzeń i obserwatorów w Magento 2 jest oparta na wzorcu publikuj-subskrybuj. Korzystając ze zdarzeń i obserwatorów, możesz uruchomić swój niestandardowy kod w odpowiedzi na określone zdarzenie Magento, a nawet niestandardowe zdarzenie.

Czym są wydarzenia w Magento?

Zdarzenia są wysyłane przez moduły po wyzwoleniu określonych akcji. Oprócz własnych zdarzeń Magento umożliwia tworzenie własnych zdarzeń, które można rozsyłać w kodzie. Gdy zdarzenie jest wywoływane, może przekazać dane do dowolnych obserwatorów skonfigurowanych do obserwowania tego zdarzenia.

Czym są obserwatorzy w Magento?

Obserwatorzy to pewien rodzaj klasy Magento, która może wpływać na ogólne zachowanie, wydajność lub zmieniać logikę biznesową. Obserwatorzy są uruchamiani za każdym razem, gdy zdarzenie, które mają obserwować, jest wywoływane przez menedżera zdarzeń.

Teraz, gdy rozumiemy terminologię, wykorzystajmy je!

1. Utwórz plik event.xml

Możesz utworzyć plik event.xml dla różnych obszarów:

• Obszar globalny: app/code/Simi/HelloWorld/etc/events.xml
• Obszar frontendu: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Obszar administracyjny: 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. Utwórz klasę obserwatora

Aby utworzyć obserwatora, musisz umieścić plik swojej klasy w katalogu <moduł-root>/Observer . Twoja klasa obserwatora powinna zaimplementować Magento\Framework\Event\ObserverInterface i zdefiniować jego funkcję wykonywania .

Poniżej przykład podstawowej struktury klasy obserwatora:

 przestrzeń nazw MojaFirma\MyModule\Observer;

użyj Magento\Framework\Event\ObserverInterface;

klasa MyObserver implementuje ObserverInterface
{
  funkcja publiczna __construct()
  {
    // Kod inicjalizacji obserwatora...
    // Możesz użyć wstrzykiwania zależności, aby uzyskać dowolną klasę, której może potrzebować ten obserwator.
  }

  wykonanie funkcji publicznej (\Magento\Framework\Event\Observer $observer)
  {
    // Kod wykonania obserwatora...
  }
}

Jedną z potężnych cech obserwatorów jest to, że potrafią używać parametrów przekazanych do zdarzenia w momencie jego wysłania.

Oto przykład obserwatora uzyskującego dane przekazane podczas wywoływania zdarzenia:

 przestrzeń nazw MojaFirma\MyModule\Observer;

użyj Magento\Framework\Event\ObserverInterface;

class AnotherObserver implementuje ObserverInterface
{
  funkcja publiczna __construct()
  {
    // Kod inicjalizacji obserwatora...
    // Możesz użyć wstrzykiwania zależności, aby uzyskać dowolną klasę, której może potrzebować ten obserwator.
  }

  wykonanie funkcji publicznej (\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Dodatkowy kod wykonania obserwatora...
  }
}

Zapisywanie się na wydarzenia

Obserwatorów można skonfigurować tak, aby oglądali określone zdarzenia w pliku events.xml.

Element xml obserwatora ma następujące właściwości:

• name (wymagane) – nazwa obserwatora dla definicji zdarzenia.
• wystąpienie (wymagane) — w pełni kwalifikowana nazwa klasy obserwatora.
• wyłączone — określa, czy ten obserwator jest aktywny, czy nie. Wartość domyślna to fałsz.
• wspólne – określa styl życia klasy. Wartość domyślna to prawda.

Poniżej znajduje się przykład, jak przypisać obserwatorów do oglądania określonych wydarzeń:

 <?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>

Należy pamiętać, że nazwy obserwatorów muszą być unikalne dla każdej definicji zdarzenia. Nie można mieć dwóch obserwatorów o tej samej nazwie w tej samej definicji zdarzenia, aby uniknąć zastąpienia.

3. Wydarzenie wysyłki

Zdarzenia można wywoływać za pomocą klasy Magento\Framework\Event\Manager . Tę klasę można uzyskać poprzez wstrzykiwanie zależności, definiując zależność w konstruktorze.

Aby wywołać zdarzenie, wywołaj funkcję dispatch klasy menedżera zdarzeń i podaj jej nazwę zdarzenia, które chcesz rozesłać wraz z tablicą danych, którą chcesz udostępnić obserwatorom.

Poniższy przykład pokazuje, jak wywołać zdarzenie z tablicą danych i bez niej.

 przestrzeń nazw MojaFirma\MójModuł;

użyj Magento\Framework\Event\ManagerInterface jako EventManager;

klasa MojaKlasa
{
  /**
   * @var EventManager
   */
  prywatny $eventManager;

  funkcja publiczna __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  funkcja publiczna coś ()
  {
    $eventData = null;
    // Kod...
    $this->eventManager->dispatch('my_module_event_before');
    // Więcej kodu ustawiającego $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Lista wydarzeń Magento 2

See also:

Jak włączyć tryb programisty w Magento 2?

Jak uzyskać adres URL obrazu produktu w Magento 2?