วิธีสร้างปลั๊กอิน Joomla เบื้องต้น

ปลั๊กอิน Joomla คือส่วนเสริมที่ทำงานเมื่อ Joomla เรียกเหตุการณ์ที่กำหนดไว้ เช่น เตรียมเนื้อหาบทความหรือบันทึกข้อมูล การสร้างปลั๊กอินเบื้องต้นเริ่มจากเลือกกลุ่มปลั๊กอิน เลือกเหตุการณ์ที่จะตอบสนอง สร้างไฟล์ติดตั้งและไฟล์ PHP แล้วติดตั้งและเปิดใช้งานเพื่อทดสอบ

❶ เข้าใจหน้าที่ของปลั๊กอินก่อนเริ่ม

ปลั๊กอินต่างจากโมดูลและคอมโพเนนต์ตรงที่ปลั๊กอินจะทำงานตาม Event หรือเหตุการณ์ของ Joomla ตัวอย่างเช่น Content Plugin สามารถทำงานเมื่อ Joomla เตรียมบทความเพื่อแสดงผล

ก่อนเขียนโค้ด ให้ตอบคำถามเหล่านี้

  • ต้องการให้ปลั๊กอินทำอะไร
  • ควรทำงานกับเหตุการณ์ใด
  • ต้องทำงานเฉพาะหน้าเว็บไซต์ หรือรวมถึงหลังบ้านและ API
  • ข้อมูลที่ปลั๊กอินอ่านหรือแก้ไขคืออะไร

เลือกเหตุการณ์ที่ตรงกับงานและประมวลผลเท่าที่จำเป็น เพราะบางกลุ่มปลั๊กอินทำงานในหลายบริบทของ Joomla

❷ วางโครงสร้างไฟล์ปลั๊กอิน

ตัวอย่างปลั๊กอินกลุ่ม Content ใน Joomla รุ่นใหม่อาจจัดไฟล์ลักษณะนี้

plg_content_example/
├── example.xml
├── services/
│   └── provider.php
├── src/
│   └── Extension/
│       └── Example.php
└── language/
    └── en-GB/
        ├── plg_content_example.ini
        └── plg_content_example.sys.ini

ไฟล์สำคัญมีหน้าที่ดังนี้

  • example.xml เป็น Manifest ระบุชื่อ กลุ่ม Namespace และไฟล์ที่ต้องติดตั้ง
  • services/provider.php ลงทะเบียนปลั๊กอินกับระบบของ Joomla
  • src/Extension/Example.php เก็บคลาสหลักและโค้ดตอบสนองต่อเหตุการณ์
  • ไฟล์ภาษาเก็บชื่อ คำอธิบาย และข้อความที่แสดงในส่วนจัดการ

ชื่อไฟล์ ชื่อโฟลเดอร์ กลุ่มปลั๊กอิน และ Namespace ต้องสัมพันธ์กันให้ถูกต้อง หากสะกดไม่ตรงกัน Joomla อาจติดตั้งส่วนเสริมได้แต่โหลดคลาสไม่สำเร็จ

❸ สร้าง Manifest และคลาสปลั๊กอิน

① ระบุข้อมูลใน Manifest

ในไฟล์ XML ระบุชนิดส่วนเสริมเป็น plugin และกำหนด group ให้ตรงกับกลุ่ม เช่น content ใส่ Namespace ที่ใช้ในโค้ด และระบุโฟลเดอร์ services กับ src ในรายการไฟล์ที่จะติดตั้ง

ตรวจสอบด้วยว่าไฟล์ Manifest ใช้ชื่อเดียวกับค่า plugin element ที่กำหนดไว้ และมีนามสกุล .xml

② เขียนคลาสและสมัครรับเหตุการณ์

คลาสหลักของปลั๊กอิน Joomla รุ่นใหม่มักสืบทอดจาก CMSPlugin และใช้ SubscriberInterface เพื่อระบุว่าแต่ละ Event จะเรียกเมธอดใด ตัวอย่างแนวคิดคือสมัครรับเหตุการณ์ onContentPrepare แล้วเขียนเมธอดที่รับ Event นั้น

public static function getSubscribedEvents(): array
{
    return [
        'onContentPrepare' => 'handleContent',
    ];
}

ชื่อเมธอดและชนิดข้อมูลที่ใช้ต้องสอดคล้องกับ Event และเวอร์ชัน Joomla ที่รองรับ ก่อนเขียนการแก้ไขเนื้อหา ให้อ่านข้อมูลจาก Event และจำกัดการทำงานเฉพาะบริบทที่ตั้งใจ เช่น บทความใน com_content

❹ ติดตั้งปลั๊กอินใน Joomla

เมื่อสร้างไฟล์ครบแล้ว ให้รวมโฟลเดอร์ปลั๊กอินเป็นไฟล์ ZIP โดยให้ Manifest อยู่ภายในแพ็กเกจ จากนั้นเข้าสู่หลังบ้าน Joomla และติดตั้งผ่านหน้า System → Install → Extensions หรือเมนูติดตั้งส่วนเสริมตามเวอร์ชันที่ใช้อยู่

หลังติดตั้ง ให้ไปที่รายการปลั๊กอิน ค้นหาชื่อปลั๊กอิน แล้วเปิดใช้งาน การติดตั้งสำเร็จไม่ได้แปลว่าปลั๊กอินเปิดทำงานแล้ว

❺ ทดสอบและแก้ปัญหา

① ทดสอบในเว็บไซต์ที่ไม่ใช่เว็บจริง

เริ่มจากเว็บทดสอบและใช้เนื้อหาตัวอย่าง ตรวจสอบว่า Event ทำงานตามที่ต้องการ และไม่เปลี่ยนเนื้อหาส่วนอื่นโดยไม่ตั้งใจ

② ตรวจสอบเมื่อปลั๊กอินไม่ทำงาน

หากไม่พบปลั๊กอินหรือเกิดข้อผิดพลาด ให้ตรวจสอบรายการต่อไปนี้

  • Manifest XML ถูกต้องและไฟล์ชื่อถูกต้อง
  • ค่า group, plugin element และ Namespace ตรงกัน
  • ไฟล์ services/provider.php ลงทะเบียนคลาสหลักได้
  • ชื่อ Event และเมธอดตรงกับเอกสารของ Joomla รุ่นที่ใช้
  • ปลั๊กอินติดตั้งแล้วและเปิดใช้งานอยู่
  • ตรวจสอบ Log ของ Joomla และ PHP เพื่อดูข้อความผิดพลาด

ปลั๊กอินกลุ่ม System ทำงานในหลายบริบทและโหลดตั้งแต่ช่วงต้นของคำขอ หากเกิดข้อผิดพลาดทางไวยากรณ์ อาจทำให้หลังบ้านเข้าไม่ได้ จึงควรทดสอบบนเว็บทดสอบและเตรียมวิธีปิดปลั๊กอินไว้ก่อนนำขึ้นเว็บจริง

❻ ทำให้ปลั๊กอินดูแลง่าย

แยกโค้ดตามหน้าที่ ตั้งชื่อคลาสและไฟล์ให้สื่อความหมาย ใส่คำอธิบายเฉพาะจุดที่จำเป็น และกำหนดเวอร์ชันกับข้อมูลผู้พัฒนาใน Manifest หากเผยแพร่ให้ผู้อื่นใช้ ควรทดสอบการติดตั้ง อัปเดต และถอนการติดตั้งด้วย

ComSiam แนะนำให้เริ่มจากปลั๊กอินขนาดเล็กที่ตอบสนอง Event เดียวก่อน เมื่อทำงานได้ถูกต้องแล้วจึงเพิ่มตัวเลือกหรือความสามารถทีละส่วน วิธีนี้ช่วยให้ตรวจหาข้อผิดพลาดและดูแลโค้ดได้ง่ายขึ้น