วิธีสร้างโมดูล Joomla เบื้องต้น

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

❶ วางแผนว่าโมดูลจะแสดงอะไร

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

ถ้าต้องการสร้างระบบที่มีหลายหน้าจอ จัดเก็บข้อมูล และมีการจัดการสิทธิ์ซับซ้อน ควรพิจารณาสร้างคอมโพเนนต์แทน

❷ เตรียมโครงสร้างไฟล์

ตัวอย่างโมดูลสำหรับหน้าเว็บไซต์ชื่อ mod_hello อาจมีไฟล์ดังนี้

mod_hello/
├── mod_hello.xml
├── services/
│   └── provider.php
├── src/
│   └── Dispatcher/
│       └── Dispatcher.php
└── tmpl/
    └── default.php

ไฟล์หลักมีหน้าที่ต่างกัน

  • mod_hello.xml ระบุชื่อโมดูล รุ่น Namespace และไฟล์ที่ต้องติดตั้ง
  • services/provider.php เชื่อมโมดูลเข้ากับระบบของ Joomla
  • src/Dispatcher/Dispatcher.php เตรียมการทำงานของโมดูล
  • tmpl/default.php กำหนดรูปแบบ HTML ที่แสดงบนหน้าเว็บ

ชื่อโมดูลและ Namespace ต้องตรงกันทุกไฟล์ รวมถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ในชื่อโฟลเดอร์และคลาส

❸ สร้างไฟล์ Manifest และไฟล์แสดงผล

① กำหนดข้อมูลใน Manifest

ใน mod_hello.xml ระบุว่าเป็นโมดูลสำหรับหน้าเว็บไซต์ด้วยค่า type="module" และ client="site" ระบุชื่อ คำอธิบาย รุ่น Namespace และโฟลเดอร์ที่ต้องการให้ Joomla ติดตั้ง เช่น services, src และ tmpl

ถ้ามีไฟล์ใหม่เพิ่มภายหลัง ต้องเพิ่มโฟลเดอร์หรือไฟล์นั้นใน Manifest ด้วย ไม่เช่นนั้น Joomla อาจไม่รวมไฟล์ดังกล่าวในแพ็กเกจติดตั้ง

② เขียนเนื้อหาที่ต้องการแสดง

สำหรับตัวอย่างเริ่มต้น โมดูลอาจแสดงข้อความสั้น ๆ เช่น “สวัสดีจากโมดูล Joomla” ในไฟล์เลย์เอาต์ tmpl/default.php ควรป้องกันการเปิดไฟล์ PHP โดยตรงด้วยการตรวจสอบค่าคงที่ _JEXEC ก่อนเริ่มทำงาน

<?php
defined('_JEXEC') or die;
?>
<p>สวัสดีจากโมดูล Joomla</p>

เมื่อโมดูลมีข้อมูลที่ผู้ใช้กรอกหรือรับมาจากภายนอก ต้องตรวจสอบและกรองข้อมูลก่อนนำไปแสดงผล ไม่ควรพิมพ์ข้อมูลดิบลงใน HTML

❹ ติดตั้งโมดูลใน Joomla

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

เมื่อติดตั้งสำเร็จ ให้ไปที่ Content → Site Modules แล้วเปิดรายการโมดูลที่ติดตั้งไว้

❺ กำหนดตำแหน่งและหน้าที่แสดง

① เลือกตำแหน่งของเทมเพลต

กำหนดตำแหน่งที่ต้องการให้โมดูลแสดง เช่น sidebar หรือ footer ตำแหน่งที่เลือกได้ขึ้นอยู่กับเทมเพลตที่ใช้งาน หากไม่แน่ใจว่าตำแหน่งอยู่ตรงไหน ให้ตรวจสอบเอกสารของเทมเพลตหรือเปิดการแสดงตำแหน่งโมดูลสำหรับตรวจสอบในสภาพแวดล้อมทดสอบ

② เผยแพร่และกำหนดหน้าที่แสดง

เปลี่ยนสถานะเป็น Published แล้วตั้งค่า Menu Assignment เพื่อเลือกว่าจะแสดงทุกหน้า หรือเฉพาะบางรายการเมนู บันทึกการตั้งค่าและเปิดหน้าเว็บไซต์เพื่อตรวจสอบตำแหน่งจริง

❻ ตรวจสอบเมื่อโมดูลไม่ปรากฏ

ถ้าไม่เห็นโมดูลบนหน้าเว็บ ให้ตรวจสอบว่าโมดูลเผยแพร่แล้ว เลือกตำแหน่งที่มีอยู่ในเทมเพลต และกำหนดหน้าแสดงผลถูกต้องหรือไม่ หากพบข้อผิดพลาด Class not found ให้ตรวจ Namespace, ชื่อคลาส, ชื่อไฟล์ และตัวพิมพ์เล็กตัวพิมพ์ใหญ่ในโฟลเดอร์

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