Okvir XMF

2.5.x ✅ 4.0.x ✅

Most do moderne XOOPS

XMF radi u i XOOPS 2.5.x i XOOPS 4.0.x. To je preporučeni način da modernizirate svoj modules danas dok se pripremate za XOOPS 4.0. XMF pruža PSR-4 automatsko učitavanje, prostore imena i pomoćnike koji olakšavaju prijelaz.

XOOPS Module Framework (XMF) moćna je biblioteka dizajnirana da pojednostavi i standardizira razvoj modula XOOPS. XMF pruža moderne prakse PHP uključujući prostore imena, automatsko učitavanje i sveobuhvatan skup pomoćnih classes koji smanjuju standardni kod i poboljšavaju mogućnost održavanja.

Što je XMF?

XMF je zbirka classes i uslužnih programa koji pružaju:

• Podrška za moderni PHP - Potpuna podrška za prostor naziva s automatskim učitavanjem PSR-4
• Rukovanje zahtjevima - Sigurna provjera valjanosti i dezinfekcija unosa
• Module Helpers - Pojednostavljeni pristup konfiguracijama i objektima modula
• Sustav dozvola - Upravljanje dozvolama jednostavno za korištenje
• Database Utilities - Alati za migraciju shema i upravljanje tablicama
• JWT podrška - JSON Implementacija web tokena za sigurnu autentifikaciju
• Generacija metapodataka - SEO i uslužni programi za izdvajanje sadržaja
• Administratorsko sučelje - Stranice standardiziranog modula administration

XMF Pregled komponenti

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

Ključne značajke

Prostori imena i automatsko učitavanje

Svi XMF classes nalaze se u Xmf imenskom prostoru. Klase se automatski učitavaju kada se referenciraju - nije potreban priručnik includes.

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

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

Sigurno rukovanje zahtjevima

Zahtjev class pruža siguran pristup podacima HTTP zahtjeva s ugrađenom sanacijom:

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

Pomoćni sustav modula

Module Helper pruža praktičan pristup funkcijama vezanim uz module:

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

Upravljanje dozvolama

Permission-Helper pojednostavljuje rukovanje dozvolama XOOPS:

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

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

Struktura dokumentacije

Osnove

• Getting-Started-with-XMF - Instalacija i osnovna upotreba
• XMF-Zahtjev - Rukovanje zahtjevima i provjera valjanosti unosa
• XMF-Module-Helper - Module helper class upotreba

Recepti

• Permission-Helper - Rad s dozvolama
• Module-Admin-Pages - Stvaranje standardiziranih admin sučelja

Referenca

• JWT - Implementacija JSON web tokena
• baza podataka - Uslužni programi baze podataka i upravljanje shemom
• Metagen - Pomoćni programi za metapodatke i SEO

Zahtjevi

• XOOPS 2.5.8 ili noviji
• PHP 7.2 ili noviji (preporučuje se PHP 8.x)

InstalacijaXMF je included sa XOOPS 2.5.8 i novijim verzijama. Za starije verzije ili ručnu instalaciju:

1. Preuzmite paket XMF iz repozitorija XOOPS
2. Ekstrahirajte u svoj direktorij XOOPS /class/xmf/
3. Autoloader će automatski upravljati učitavanjem class

Primjer brzog početka

Evo cjelovitog primjera koji prikazuje uobičajene obrasce upotrebe 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;
}

Resursi

• XMF GitHub spremište
• XOOPS Web stranica projekta

---

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