דלגו לתוכן

הוקס ואירועים

XOOPS מספקת הוקס ואירועים כנקודות הרחבה המאפשרות למודולים לקיים אינטראקציה עם פונקציונליות ליבה ואחד עם השני ללא תלות ישירה.

היבטוויםאירועים
מטרהשנה behavior/dataלהגיב להתרחשויות
חזוריכול להחזיר נתונים שהשתנובדרך כלל בטל
תזמוןBefore/during פעולהלאחר פעולה
דפוסשרשרת סינוןObserver/pub-sub
// Register a hook in xoops_version.php
$modversion['hooks'][] = [
'name' => 'user.profile.display',
'callback' => 'mymodule_hook_user_profile',
'priority' => 10,
];
include/hooks.php
function mymodule_hook_user_profile(array $data): array
{
$userId = $data['user_id'];
// Add custom profile fields
$data['fields']['reputation'] = mymodule_get_user_reputation($userId);
$data['fields']['badges'] = mymodule_get_user_badges($userId);
return $data;
}
שם הוקנתוניםתיאור
user.profile.displayמערך נתוני משתמששנה תצוגת פרופיל
content.renderתוכן HTMLסינון פלט תוכן
form.submitנתוני טופסValidate/modify נתוני טופס
search.resultsמערך תוצאותסנן תוצאות חיפוש
menu.mainפריטי תפריטשנה תפריט ראשי
// In your module code
$eventHandler = xoops_getHandler('event');
$eventHandler->trigger('mymodule.article.created', [
'article_id' => $article->id(),
'author_id' => $article->authorId(),
'title' => $article->title(),
]);
class/Preload.php
class MyModulePreload extends \Xmf\Module\Helper\AbstractHelper
{
public function eventMymoduleArticleCreated(array $args): void
{
$articleId = $args['article_id'];
// Notify subscribers
$this->notifyNewArticle($articleId);
}
public function eventUserLogin(array $args): void
{
$userId = $args['userid'];
// Update last login for module
$this->updateUserActivity($userId);
}
}

טען מראש הפניה לאירועים

Section titled “טען מראש הפניה לאירועים”
// Header/Footer
public function eventCoreHeaderStart(array $args): void {}
public function eventCoreHeaderEnd(array $args): void {}
public function eventCoreFooterStart(array $args): void {}
public function eventCoreFooterEnd(array $args): void {}
// Includes
public function eventCoreIncludeCommonStart(array $args): void {}
public function eventCoreIncludeCommonEnd(array $args): void {}
// Exceptions
public function eventCoreException(array $args): void {}
public function eventUserLogin(array $args): void {}
public function eventUserLogout(array $args): void {}
public function eventUserRegister(array $args): void {}
public function eventUserActivate(array $args): void {}
public function eventUserDelete(array $args): void {}
public function eventSystemModuleInstall(array $args): void {}
public function eventSystemModuleUninstall(array $args): void {}
public function eventSystemModuleUpdate(array $args): void {}
public function eventSystemModuleActivate(array $args): void {}
public function eventSystemModuleDeactivate(array $args): void {}

אירועי מודול מותאם אישית

Section titled “אירועי מודול מותאם אישית”
// Define event constants
class ArticleEvents
{
public const CREATED = 'mymodule.article.created';
public const UPDATED = 'mymodule.article.updated';
public const DELETED = 'mymodule.article.deleted';
public const PUBLISHED = 'mymodule.article.published';
}
class ArticleService
{
public function publish(Article $article): void
{
$article->publish();
$this->repository->save($article);
// Trigger event
$GLOBALS['xoopsPreload']->triggerEvent(
ArticleEvents::PUBLISHED,
['article' => $article]
);
}
}
// In another module's Preload.php
public function eventMymoduleArticlePublished(array $args): void
{
$article = $args['article'];
// Index for search
$this->searchIndexer->index($article);
// Update sitemap
$this->sitemapGenerator->addUrl($article->url());
}
  1. השתמש בשמות ספציפיים - פורמט module.entity.action
  2. העברת נתונים מינימליים - רק מה שמאזינים צריכים
  3. אירועי מסמך - רשימת אירועים במסמכי מודול
  4. הימנע מתופעות לוואי - שמור על מיקוד המאזינים
  5. טפל בשגיאות - אל תיתן לשגיאות מאזינים לשבור את הזרימה
  • Event-System - תיעוד אירועים מפורט
  • ../03-Module-Development/Module-Development - פיתוח מודול
  • ../07-XOOPS-4.0/Implementation-Guides/Event-System-Guide - PSR-14 אירועים