Daftar Acara Magento 2 dan Cara Menggunakannya

Dalam posting ini kami akan menunjukkan cara menggunakan event di Magento 2. Tapi pertama-tama kita perlu memahami tentang event dan observer . Implementasi event dan observer di Magento 2 didasarkan pada pola publish-subscribe. Dengan menggunakan peristiwa dan pengamat, Anda dapat menjalankan kode khusus sebagai respons terhadap peristiwa Magento tertentu atau bahkan peristiwa khusus.

Apa itu acara di Magento?

Acara dikirim oleh modul ketika tindakan tertentu dipicu. Selain acaranya sendiri, Magento memungkinkan Anda membuat acara sendiri yang dapat dikirim dalam kode Anda. Saat sebuah acara dikirim, itu bisa meneruskan data ke pengamat mana pun yang dikonfigurasi untuk menonton acara itu.

Apa itu pengamat di Magento?

Pengamat adalah jenis kelas Magento tertentu yang dapat memengaruhi perilaku umum, kinerja, atau mengubah logika bisnis. Pengamat dieksekusi setiap kali acara yang mereka konfigurasikan untuk ditonton dikirim oleh manajer acara.

Sekarang setelah kita memahami istilah-istilah tersebut, mari kita gunakan!

1. Buat file event.xml

Anda dapat membuat file event.xml untuk area yang berbeda:

• Area global: app/code/Simi/HelloWorld/etc/events.xml
• Area frontend: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Area admin: app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml versi="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <nama acara="my_module_event_before">
        <namapengamat="myObserverName" instance="Perusahaan Saya\MyModule\Observer\MyObserver" />
    </acara>
    <nama acara="my_module_event_after">
        <namapengamat="myObserverName" instance="PerusahaanSaya\MyModule\Observer\AnotherObserver" />
    </acara>
</config>

2. Buat kelas Pengamat

Untuk membuat pengamat, Anda harus menempatkan file kelas Anda di bawah direktori <module-root>/Observer Anda. Kelas pengamat Anda harus mengimplementasikan Magento\Framework\Event\ObserverInterface dan mendefinisikan fungsi eksekusinya .

Di bawah ini adalah contoh struktur kelas pengamat dasar:

 namespace MyCompany\MyModule\Observer;

gunakan Magento\Framework\Event\ObserverInterface;

kelas MyObserver mengimplementasikan ObserverInterface
{
  fungsi publik __construct()
  {
    // Kode inisialisasi pengamat...
    // Anda dapat menggunakan injeksi dependensi untuk mendapatkan kelas apa pun yang mungkin dibutuhkan pengamat ini.
  }

  eksekusi fungsi publik(\Magento\Framework\Event\Observer $observer)
  {
    // Kode eksekusi pengamat...
  }
}

Salah satu fitur hebat dari pengamat adalah mereka dapat menggunakan parameter yang diteruskan ke acara saat dikirim.

Berikut adalah contoh pengamat yang memperoleh data yang diteruskan saat acara dikirim:

 namespace MyCompany\MyModule\Observer;

gunakan Magento\Framework\Event\ObserverInterface;

class AnotherObserver mengimplementasikan ObserverInterface
{
  fungsi publik __construct()
  {
    // Kode inisialisasi pengamat...
    // Anda dapat menggunakan injeksi dependensi untuk mendapatkan kelas apa pun yang mungkin dibutuhkan pengamat ini.
  }

  eksekusi fungsi publik(\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Kode eksekusi pengamat tambahan...
  }
}

Berlangganan acara

Pengamat dapat dikonfigurasi untuk menonton acara tertentu di file events.xml.

Elemen pengamat xml memiliki properti berikut:

• name (wajib) – Nama pengamat untuk definisi peristiwa.
• instance (wajib) – Nama kelas pengamat yang memenuhi syarat.
• dinonaktifkan – Menentukan apakah pengamat ini aktif atau tidak. Nilai default salah.
• shared – Menentukan gaya hidup kelas. Standarnya benar.

Di bawah ini adalah contoh cara menugaskan pengamat untuk menonton acara tertentu:

 <?xml versi="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <nama acara="my_module_event_before">
        <namapengamat="myObserverName" instance="PerusahaanSaya\MyModule\Observer\MyObserver" />
    </acara>
    <nama acara="my_module_event_after">
        <namapengamat="myObserverName" instance="PerusahaanSaya\MyModule\Observer\AnotherObserver" />
    </acara>
</config>

Perhatikan bahwa nama pengamat harus unik per definisi peristiwa. Anda tidak dapat memiliki dua pengamat dengan nama yang sama dalam definisi peristiwa yang sama untuk menghindari penggantian.

3. Acara pengiriman

Acara dapat dikirim menggunakan kelas Magento\Framework\Event\Manager . Kelas ini dapat diperoleh melalui injeksi ketergantungan dengan mendefinisikan ketergantungan pada konstruktor Anda.

Untuk mengirimkan acara, panggil fungsi pengiriman dari kelas manajer acara dan berikan nama acara yang ingin Anda kirim bersama dengan larik data yang ingin Anda berikan kepada pengamat.

Contoh berikut menunjukkan kepada Anda cara mengirimkan peristiwa dengan dan tanpa larik data.

 namespace MyCompany\MyModule;

gunakan Magento\Framework\Event\ManagerInterface sebagai EventManager;

kelas Kelasku
{
  /**
   * @var EventManager
   */
  pribadi $eventManager;

  fungsi publik __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  fungsi publik sesuatu()
  {
    $eventData = nol;
    // kode...
    $this->eventManager->dispatch('my_module_event_before');
    // Kode lainnya yang menyetel $eventData...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Daftar acara Magento 2

See also:

Cara mengaktifkan Mode Pengembang di Magento 2

Cara Mendapatkan URL Gambar Produk di Magento 2