XMF Framework

2.5.x ✅ 4.0.x ✅

:::טיפ[הגשר למודרני XOOPS] XMF עובד ב-גם XOOPS 2.5.x וגם XOOPS 4.0.x. זו הדרך המומלצת למודרניזציה של המודולים שלך היום תוך כדי הכנה ל-XOOPS 4.0. XMF מספק PSR-4 טעינה אוטומטית, מרחבי שמות ועוזרים שמחליקים את המעבר. :::

XOOPS Module Framework (XMF) היא ספרייה רבת עוצמה שנועדה לפשט ולתקן את פיתוח המודול XOOPS. XMF מספקת שיטות PHP מודרניות, כולל מרחבי שמות, טעינה אוטומטית וסדרה מקיפה של כיתות עוזרות המפחיתות את קוד ה-boilerplate ומשפרים את יכולת התחזוקה.

מה זה XMF?

XMF הוא אוסף של מחלקות וכלי עזר המספקים:

• תמיכה PHP מודרנית - תמיכה מלאה במרחב השמות עם טעינה אוטומטית של PSR-4
• טיפול בבקשות - אימות קלט מאובטח וחיטוי
• מסייעי מודולים - גישה פשוטה לתצורות ואובייקטים של מודול
• מערכת הרשאות - ניהול הרשאות קל לשימוש
• כלי עזר למסד נתונים - העברת סכימה וכלים לניהול טבלאות
• תמיכה בJWT - יישום אסימון אינטרנט של JSON לאימות מאובטח
• יצירת מטא נתונים - SEO וכלי עזר לחילוץ תוכן
• ממשק ניהול - דפי ניהול מודול סטנדרטיים

XMF סקירת רכיבים

graph TB
    subgraph XMF["XMF Framework"]
        direction TB
        subgraph Core["Core Components"]
            Request["🔒 Request<br/>Input Handling"]
            Module["📦 Module Helper<br/>Config & Handlers"]
            Perm["🔑 Permission<br/>Access Control"]
        end

        subgraph Utils["Utilities"]
            DB["🗄️ Database<br/>Schema Tools"]
            JWT["🎫 JWT<br/>Token Auth"]
            Meta["📊 Metagen<br/>SEO Utils"]
        end

        subgraph Admin["Admin Tools"]
            AdminUI["🎨 Admin UI<br/>Standardized Pages"]
            Icons["🖼️ Icons<br/>Font Awesome"]
        end
    end

    subgraph Module["Your Module"]
        Controller["Controller"]
        Handler["Handler"]
        Template["Template"]
    end

    Controller --> Request
    Controller --> Module
    Controller --> Perm
    Handler --> DB
    Template --> AdminUI

    style XMF fill:#e3f2fd,stroke:#1976d2
    style Core fill:#e8f5e9,stroke:#388e3c
    style Utils fill:#fff3e0,stroke:#f57c00
    style Admin fill:#fce4ec,stroke:#c2185b

תכונות עיקריות

מרחבי שמות וטעינה אוטומטית

כל מחלקות XMF שוכנות במרחב השמות Xmf. השיעורים נטענים אוטומטית עם הפניה - אין צורך במדריך כולל.

use Xmf\Request;
use Xmf\Module\Helper;

// Classes load automatically when used
$input = Request::getString('input', '');
$helper = Helper::getHelper('mymodule');

טיפול בטוח בבקשות

מחלקת הבקשה מספקת גישה בטוחה לפי סוג לנתוני בקשות HTTP עם חיטוי מובנה:

flowchart LR
    subgraph Input["Raw Input"]
        GET["$_GET"]
        POST["$_POST"]
        REQUEST["$_REQUEST"]
    end

    subgraph XMF["Xmf\\Request"]
        Validate["Type Validation"]
        Sanitize["Sanitization"]
        Default["Default Values"]
    end

    subgraph Output["Safe Output"]
        Int["getInt()"]
        Str["getString()"]
        Email["getEmail()"]
        Bool["getBool()"]
    end

    GET --> XMF
    POST --> XMF
    REQUEST --> XMF
    XMF --> Int
    XMF --> Str
    XMF --> Email
    XMF --> Bool

    style Input fill:#ffcdd2,stroke:#c62828
    style XMF fill:#fff3e0,stroke:#f57c00
    style Output fill:#c8e6c9,stroke:#2e7d32

use Xmf\Request;

$id = Request::getInt('id', 0);
$name = Request::getString('name', '');
$email = Request::getEmail('email', '');

מערכת עוזר מודול

מסייע המודול מספק גישה נוחה לפונקציונליות הקשורה למודול:

$helper = \Xmf\Module\Helper::getHelper('mymodule');

// Access module configuration
$configValue = $helper->getConfig('setting_name', 'default');

// Get module object
$module = $helper->getModule();

// Access handlers
$handler = $helper->getHandler('items');

ניהול הרשאות

ה-Permission-Helper מפשט את הטיפול בהרשאות XOOPS:

$permHelper = new \Xmf\Module\Helper\Permission();

// Check user permission
if ($permHelper->checkPermission('view', $itemId)) {
    // User has permission
}

מבנה תיעוד

יסודות

• תחילת העבודה-עם-XMF - התקנה ושימוש בסיסי
• XMF-Request - טיפול בבקשות ואימות קלט
• XMF-Module-Helper - שימוש בכיתה עוזר מודול

מתכונים

• Permission-Helper - עבודה עם הרשאות
• Module-Admin-Pages - יצירת ממשקי ניהול סטנדרטיים

הפניה

• JWT - JSON יישום אסימון אינטרנט
• מסד נתונים - כלי עזר למסד נתונים וניהול סכימה
• Metagen - מטא נתונים ו-SEO כלי עזר

דרישות

• XOOPS 2.5.8 ואילך
• PHP 7.2 ואילך (מומלץ PHP 8.x)

התקנה

XMF כלול עם XOOPS 2.5.8 ואילך. עבור גרסאות קודמות או התקנה ידנית:

1. הורד את חבילת XMF ממאגר XOOPS
2. חלץ לספריית XOOPS /class/xmf/ שלך
3. הטעינה האוטומטית יטפל בטעינת הכיתה באופן אוטומטי

דוגמה להתחלה מהירה

הנה דוגמה מלאה המציגה דפוסי שימוש נפוצים של XMF:

<?php
use Xmf\Request;
use Xmf\Module\Helper;
use Xmf\Module\Helper\Permission;

// Get module helper
$helper = Helper::getHelper('mymodule');

// Get configuration values
$itemsPerPage = $helper->getConfig('items_per_page', 10);

// Handle request input
$op = Request::getCmd('op', 'list');
$id = Request::getInt('id', 0);

// Check permissions
$permHelper = new Permission();
if (!$permHelper->checkPermission('view', $id)) {
    redirect_header('index.php', 3, 'Access denied');
}

// Process based on operation
switch ($op) {
    case 'view':
        $handler = $helper->getHandler('items');
        $item = $handler->get($id);
        // ... display item
        break;
    case 'list':
    default:
        // ... list items
        break;
}

משאבים

• XMF GitHub מאגר
• אתר פרויקט XOOPS

---

#xmf #xoops #framework #php #module-development