Joomla Bài học 38: Xây dựng hệ thống Plugin tích hợp (Plugins và Event Dispatcher) cho Custom Component
Trong kiến trúc phần mềm hướng đối tượng, một Custom Component tốt không chỉ chạy độc lập mà còn phải có khả năng mở rộng (Extensibility). Giống như cách WordPress có các Hooks hay Laravel có hệ thống Events & Listeners, Joomla sở hữu một cơ chế quản lý sự kiện cực kỳ mạnh mẽ mang tên Event Dispatcher (dựa trên chuẩn Joomla\Event).
Trong Joomla Bài học 38, chúng ta sẽ học cách thiết kế một Event Dispatcher bên trong Custom Component com_custom để phát ra các sự kiện tùy chỉnh (ví dụ: onCustomAfterSaveItem), đồng thời tự tay viết một Plugin mở rộng đón nhận sự kiện đó để thực hiện các tác vụ ngầm như gửi email thông báo hoặc ghi log.
1. Bản chất cơ chế Event Dispatcher trong Joomla 5
Joomla 5 sử dụng thư viện joomla/event hiện đại. Quy trình hoạt động gồm 3 bước:
-
Trigger (Phát sự kiện): Tại các thời điểm quan trọng trong Model hoặc Controller của Component (ví dụ: ngay sau khi lưu thành công một bản ghi), bạn gọi trình điều phối sự kiện (
DispatcherInterface) để "la lớn" lên hệ thống rằng một sự kiện vừa xảy ra kèm theo dữ liệu. -
Listen (Lắng nghe): Các Plugin bên thứ ba đăng ký lắng nghe sự kiện đó sẽ tự động được kích hoạt, nhận dữ liệu và thực thi logic riêng của mình mà không cần sửa một dòng code gốc nào trong Component.
2. Bước 1: Phát sự kiện từ Component Model (Model/ItemModel.php)
Hãy mở lại lớp lưu trữ dữ liệu ItemModel của Component com_custom (mà chúng ta đã làm ở Bài 34) và bổ sung mã lệnh phát sự kiện ngay sau khi câu lệnh INSERT hoặc UPDATE thực thi thành công:
PHP
<?php
namespace MyCompany\Component\Custom\Administrator\Model;
\defined('_JEXEC') or die;
use Joomla\CMS\MVC\Model\AdminModel;
use Joomla\Event\Event; // Import lớp Event chuẩn của Joomla 5
class ItemModel extends AdminModel
{
// ... các phương thức cũ ...
protected function save($data)
{
// 1. Thực thi tiến trình lưu dữ liệu gốc xuống Database
$isNew = empty($data['id']);
$result = parent::save($data);
if ($result) {
// 2. Lấy đối tượng Dispatcher từ Container của ứng dụng
$dispatcher = $this->getDispatcher();
// 3. Tạo một Event tùy chỉnh (Ví dụ: onCustomAfterSaveItem)
// Truyền kèm dữ liệu bản ghi vừa lưu và trạng thái mới hay cũ
$event = new Event('onCustomAfterSaveItem', [
'item' => $this->getItem($data['id'] ?? $this->getState($this->getName() . '.id')),
'isNew' => $isNew,
'data' => $data
]);
// 4. Phát sự kiện ra toàn hệ thống để các Plugin đón nhận
$dispatcher->dispatch('onCustomAfterSaveItem', $event);
}
return $result;
}
}
3. Bước 2: Xây dựng Custom Plugin đón nhận sự kiện (plg_custom_logger)
Bây giờ, chúng ta sẽ tự tay viết một Plugin thuộc nhóm content hoặc nhóm riêng của component để lắng nghe sự kiện onCustomAfterSaveItem vừa phát ra.
A. Cấu trúc thư mục của Plugin:
Plaintext
plg_custom_logger/
├── custom_logger.xml <-- File Manifest định danh Plugin
└── src/
└── Extension/
└── CustomLogger.php <-- Lớp xử lý sự kiện (Subscriber)
B. Khai báo Manifest (custom_logger.xml):
XML
<?xml version="1.0" encoding="utf-8"?>
<extension type="plugin" group="content" method="upgrade">
<name>plg_content_custom_logger</name>
<author>Hieu Nguyen</author>
<version>1.0.0</version>
<description>Plugin lắng nghe sự kiện từ Custom Component để ghi log hoạt động.</description>
<files>
<filename plugin="custom_logger">custom_logger.php</filename>
<folder>src</folder>
</files>
</extension>
C. Lập trình lớp Plugin Subscriber (src/Extension/CustomLogger.php):
Joomla 5 khuyến khích sử dụng giao diện SubscriberInterface giúp định nghĩa rõ ràng các sự kiện mà plugin này đăng ký lắng nghe:
PHP
namespace MyCompany\Plugin\Content\CustomLogger\Extension;
\defined('_JEXEC') or die;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Event\Event;
use Joomla\Event\SubscriberInterface;
use Joomla\CMS\Log\Log;
class CustomLogger extends CMSPlugin implements SubscriberInterface
{
/**
* Khai báo danh sách các sự kiện mà Plugin này muốn đăng ký lắng nghe
*/
public static function getSubscribedEvents(): array
{
return [
'onCustomAfterSaveItem' => 'handleAfterSaveItem',
];
}
/**
* Hàm xử lý khi sự kiện 'onCustomAfterSaveItem' được phát ra từ Component
*/
public function handleAfterSaveItem(Event $event): void
{
// 1. Trích xuất dữ liệu được truyền từ Event arguments
$item = $event->getArgument('item');
$isNew = $event->getArgument('isNew');
// 2. Thực hiện tác vụ ngầm (Ví dụ: Ghi log hệ thống hoặc gửi thông báo)
$action = $isNew ? 'Tạo mới' : 'Cập nhật';
$logMessage = sprintf("Custom Component Log: Đã %s thành công bản ghi ID #%d - Tiêu đề: '%s'", $action, $item->id, $item->title);
// Sử dụng hệ thống Log chuẩn của Joomla để ghi vào thư mục /logs/
Log::add($logMessage, Log::INFO, 'custom_component');
}
}
Và tạo một file entry point tối giản custom_logger.php tại gốc thư mục plugin để load namespace:
PHP
<?php
\defined('_JEXEC') or die;
use Joomla\CMS\Factory;
use MyCompany\Plugin\Content\CustomLogger\Extension\CustomLogger;
$container = Factory::getContainer();
$container->alias('plg_content_custom_logger', CustomLogger::class)
->share(CustomLogger::class, function (\Interop\Container\ContainerInterface $container) {
$plugin = new CustomLogger(
$container->get(\Joomla\Event\DispatcherInterface::class),
(array) \Joomla\CMS\Plugin\PluginHelper::getPlugin('content', 'custom_logger')
);
return $plugin;
}, true);
$container->get(CustomLogger::class);
4. Tổng kết bài học
-
Hiểu rõ mô hình Event-Driven Architecture giúp tách biệt logic nghiệp vụ cốt lõi của Component ra khỏi các tác vụ phụ trợ (như gửi email, ghi log, đồng bộ API).
-
Thành thạo việc khởi tạo và phát sự kiện bằng lớp
Eventkết hợp vớiDispatcherInterfacetrong Model. -
Lập trình thành công một Custom Plugin tuân thủ chuẩn
SubscriberInterfaceđể lắng nghe sự kiện động.
Trong Bài học 39, chúng ta sẽ tiếp tục khám phá một kỹ thuật nâng cao khác giúp Component của bạn trở nên thông minh và trực quan hơn: Tích hợp hệ thống Tags và Custom Fields vào Custom Component.
All rights reserved
