Список событий Magento 2 и как их использовать

В этом посте мы покажем вам, как использовать события в Magento 2. Но сначала нам нужно понять, что такое события и наблюдатели . Реализация событий и наблюдателей в Magento 2 основана на шаблоне публикации-подписки. Используя события и наблюдатели, вы можете запускать свой собственный код в ответ на определенное событие Magento или даже пользовательское событие.

Что такое события в Magento?

События отправляются модулями, когда инициируются определенные действия. Помимо собственных событий, Magento позволяет создавать собственные события, которые можно отправлять в коде. Когда событие отправляется, оно может передавать данные любым наблюдателям, настроенным для наблюдения за этим событием.

Что такое наблюдатели в Magento?

Наблюдатели — это определенный тип класса Magento, который может влиять на общее поведение, производительность или изменять бизнес-логику. Наблюдатели выполняются всякий раз, когда событие, для наблюдения за которым они настроены, отправляется диспетчером событий.

Теперь, когда мы поняли терминологию, давайте применим ее!

1. Создайте файл event.xml

Вы можете создать файл event.xml для разных областей:

• Глобальная область: app/code/Simi/HelloWorld/etc/events.xml
• Область внешнего интерфейса: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Область администратора: app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml версия="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <имя события="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </событие>
    <имя события="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </событие>
</config>

2. Создайте класс наблюдателя

Чтобы создать наблюдатель, вы должны поместить файл класса в каталог <module-root>/Observer . Ваш класс наблюдателя должен реализовать Magento\Framework\Event\ObserverInterface и определить его функцию выполнения .

Ниже приведен пример базовой структуры класса наблюдателя:

 пространство имен MyCompany\MyModule\Observer;

используйте Magento\Framework\Event\ObserverInterface;

класс MyObserver реализует ObserverInterface
{
  публичная функция __construct()
  {
    // Код инициализации наблюдателя...
    // Вы можете использовать внедрение зависимостей, чтобы получить любой класс, который может понадобиться этому наблюдателю.
  }

  выполнение публичной функции (\Magento\Framework\Event\Observer $observer)
  {
    // Код выполнения наблюдателя...
  }
}

Одной из мощных функций наблюдателей является то, что они могут использовать параметры, переданные в событие при его отправке.

Вот пример получения наблюдателем данных, переданных при отправке события:

 пространство имен MyCompany\MyModule\Observer;

используйте Magento\Framework\Event\ObserverInterface;

класс AnotherObserver реализует ObserverInterface
{
  публичная функция __construct()
  {
    // Код инициализации наблюдателя...
    // Вы можете использовать внедрение зависимостей, чтобы получить любой класс, который может понадобиться этому наблюдателю.
  }

  выполнение публичной функции (\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Дополнительный код выполнения наблюдателя...
  }
}

Подписка на события

Наблюдатели можно настроить для наблюдения за определенными событиями в файле events.xml.

Элемент наблюдателя xml имеет следующие свойства:

• name (обязательно) — имя наблюдателя для определения события.
• instance (обязательно) — полное имя класса наблюдателя.
• disabled — определяет, активен ли этот наблюдатель или нет. Значение по умолчанию — ложь.
• общий — определяет образ жизни класса. Значение по умолчанию верно.

Ниже приведен пример того, как назначить наблюдателей для наблюдения за определенными событиями:

 <?xml версия="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <имя события="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </событие>
    <имя события="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </событие>
</config>

Обратите внимание, что имена наблюдателей должны быть уникальными для каждого определения события. Вы не можете иметь двух наблюдателей с одинаковым именем в одном и том же определении события, чтобы избежать переопределения.

3. Отправка события

События можно отправлять с помощью класса Magento\Framework\Event\Manager . Этот класс можно получить с помощью внедрения зависимостей, определив зависимость в вашем конструкторе.

Чтобы отправить событие, вызовите функцию отправки класса диспетчера событий и укажите имя события, которое вы хотите отправить, вместе с массивом данных, которые вы хотите предоставить наблюдателям.

В следующем примере показано, как отправить событие с массивом данных и без него.

 пространство имен MyCompany\MyModule;

используйте Magento\Framework\Event\ManagerInterface как EventManager;

класс MyClass
{
  /**
   * @var EventManager
   */
  частный $eventManager;

  публичная функция __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  публичная функция что-то()
  {
    $eventData = ноль;
    // Код...
    $this->eventManager->dispatch('my_module_event_before');
    // Еще код, который устанавливает $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Список событий Magento 2

See also:

Как включить режим разработчика в Magento 2

Как получить URL-адрес изображения продукта в Magento 2