قائمة أحداث Magento 2 وكيفية استخدامها

في هذا المنشور ، سنوضح لك كيفية استخدام الأحداث في Magento 2. لكن أولاً نحتاج إلى فهم الأحداث والمراقبين . يعتمد تنفيذ الأحداث والمراقبين في Magento 2 على نمط النشر والاشتراك. باستخدام الأحداث والمراقبين ، يمكنك تشغيل التعليمات البرمجية المخصصة استجابةً لحدث 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 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" مثيل = "MyCompany \ MyModule \ Observer \ MyObserver" />
    </event>
    <event name = "my_module_event_after">
        <Observer name = "myObserverName" مثيل = "MyCompany \ MyModule \ Observer \ AnotherObserver" />
    </event>
</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 ؛

فئة OtherObserver تنفذ ObserverInterface
{
  الوظيفة العامة __construct ()
  {
    // رمز تهيئة المراقب ...
    // يمكنك استخدام حقن التبعية للحصول على أي فئة قد يحتاجها هذا المراقب.
  }

  تنفيذ الوظيفة العامة (\ Magento \ Framework \ Event \ Observer $ Observer)
  {
    $ myEventData = $ Observer-> getData ('myEventData') ؛
    // رمز تنفيذ مراقب إضافي ...
  }
}

الاشتراك في الأحداث

يمكن تكوين المراقبين لمشاهدة أحداث معينة في ملف events.xml.

عنصر Observer xml له الخصائص التالية:

• name (مطلوب) - اسم المراقب لتعريف الحدث.
• المثيل (مطلوب) - اسم الفئة المؤهلة بالكامل للمراقب.
• معطل - لتحديد ما إذا كان هذا المراقب نشطًا أم لا. القيمة الافتراضية هي كاذبة.
• Shared - يحدد أسلوب حياة الفصل. الافتراضي هو الصحيح.

فيما يلي مثال على كيفية تعيين مراقبين لمشاهدة أحداث معينة:

 <؟ 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" مثيل = "MyCompany \ MyModule \ Observer \ MyObserver" />
    </event>
    <event name = "my_module_event_after">
        <اسم Observer = "myObserverName" مثيل = "MyCompany \ MyModule \ Observer \ AnotherObserver" />
    </event>
</config>

لاحظ أن أسماء المراقبين يجب أن تكون فريدة لكل تعريف حدث. لا يمكن أن يكون لديك مراقبان بنفس الاسم في نفس تعريف الحدث لتجنب التجاوز.

3. حدث الإرسال

يمكن إرسال الأحداث باستخدام فئة Magento \ Framework \ Event \ Manager . يمكن الحصول على هذه الفئة من خلال حقن التبعية من خلال تحديد التبعية في المُنشئ الخاص بك.

لإرسال حدث ، اتصل بوظيفة الإرسال لفئة مدير الحدث وقم بتزويدها باسم الحدث الذي تريد إرساله مع مجموعة من البيانات التي ترغب في تقديمها للمراقبين.

يوضح المثال التالي كيفية إرسال حدث مع أو بدون مصفوفة من البيانات.

 مساحة الاسم MyCompany \ MyModule؛

استخدام Magento \ Framework \ Event \ ManagerInterface كـ EventManager ؛

فئة MyClass
{
  / **
   *var EventManager
   * /
  خاص $ eventManager؛

  الوظيفة العامة __construct (EventManager $ eventManager)
  {
    $ this-> eventManager = $ eventManager ؛
  }

  وظيفة عامة شيء ()
  {
    $ eventData = null؛
    // شفرة...
    $ 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