XMF-keretrendszer

2.5.x ✅ 4.0.x ✅

A híd a modernhez XOOPS

A XMF mind a XOOPS 2.5.x, mind a XOOPS 4.0.x verzióban működik. A XOOPS 4.0-ra való felkészülés során ez az ajánlott módja a modulok modernizálásának. A XMF PSR-4 automatikus betöltést, névtereket és segítőket biztosít az átmenet simítására.

A XOOPS modul Framework (XMF) egy hatékony könyvtár, amelyet a XOOPS modulfejlesztés egyszerűsítésére és szabványosítására terveztek. A XMF modern PHP gyakorlatokat kínál, beleértve a névtereket, az automatikus betöltést és a segédosztályok átfogó készletét, amelyek csökkentik a sablonkódot és javítják a karbantarthatóságot.

Mi az a XMF?

A XMF olyan osztályok és segédprogramok gyűjteménye, amelyek a következőket biztosítják:

• Modern PHP támogatás - Teljes névtér támogatás PSR-4 automatikus betöltéssel
• Kéréskezelés - Biztonságos beviteli ellenőrzés és fertőtlenítés
• modulsegédek - Egyszerűsített hozzáférés a modulkonfigurációkhoz és objektumokhoz
• ** Engedélyrendszer** - Könnyen használható engedélykezelés
• Adatbázis-segédprogramok - Séma-migrációs és táblakezelő eszközök
• JWT támogatás - JSON Web Token implementáció a biztonságos hitelesítés érdekében
• Metaadatok generálása - SEO és tartalomkinyerési segédprogramok
• Adminisztrációs felület - Szabványos moduladminisztrációs oldalak

XMF Alkatrészek áttekintése

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

Főbb jellemzők

Névterek és automatikus betöltés

Minden XMF osztály a XMF névtérben található. Az osztályok automatikusan betöltődnek, amikor hivatkoznak rájuk – nincs szükség kézikönyvre.

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

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

Biztonságos kéréskezelés

A Request class típusbiztos hozzáférést biztosít a HTTP kérésadatokhoz, beépített fertőtlenítéssel:

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', '');

modul segítő rendszer

A modul Helper kényelmes hozzáférést biztosít a modullal kapcsolatos funkciókhoz:

$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');

Engedélykezelés

Az Permission-Helper leegyszerűsíti a XOOPS engedélykezelést:

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

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

Dokumentációs szerkezet

Alapok

• Getting-Start-with-XMF - Telepítés és alapvető használat
• XMF-Request - Kezelési és beviteli ellenőrzés kérése
• XMF-modul-Helper - modulsegéd osztályhasználat

Receptek

• Permission-Helper - Engedélyekkel végzett munka
• module-Admin-Pages - Szabványos adminisztrátori felületek létrehozása

Referencia

• JWT - JSON Web Token implementáció
• Adatbázis - Adatbázis-segédprogramok és sémakezelés
• Metagen - Metaadatok és SEO segédprogramok

Követelmények

• XOOPS 2.5.8 vagy újabb
• PHP 7.2 vagy újabb (PHP 8.x ajánlott)

Telepítés

A XMF a XOOPS 2.5.8 és újabb verzióihoz tartozik. Korábbi verziók vagy kézi telepítés esetén:

1. Töltse le a XMF csomagot a XOOPS tárolóból
2. Kivonat a XOOPS /class/xmf/ könyvtárból
3. Az automatikus betöltő automatikusan kezeli az osztálybetöltést

Gyorsindítási példa

Íme egy teljes példa, amely bemutatja a XMF általános használati mintáit:

<?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;
}

Források

• XMF GitHub Repository
• XOOPS projekt webhelye

---

#xmf #xoops #keretrendszer #php #modul-fejlesztés