XMF Framework

2.5.x ✅ 4.0.x ✅

Broen til moderne XOOPS

XMF fungerer i både XOOPS 2.5.x og XOOPS 4.0.x. Det er den anbefalede måde at modernisere dine moduler på i dag, mens du forbereder dig til XOOPS 4.0. XMF giver PSR-4 autoloading, navneområder og hjælpere, der glatter overgangen.

XOOPS Module Framework (XMF) er et kraftfuldt bibliotek designet til at forenkle og standardisere XOOPS-moduludvikling. XMF leverer moderne PHP-praksis, herunder navnerum, autoloading og et omfattende sæt hjælperklasser, der reducerer boilerplate-kode og forbedrer vedligeholdelsesevnen.

Hvad er XMF?

XMF er en samling af klasser og hjælpeprogrammer, der giver:

• Moderne PHP-understøttelse - Fuld navneområdeunderstøttelse med PSR-4 autoloading
• Request Handling - Sikker inputvalidering og desinficering
• Modulhjælpere - Forenklet adgang til modulkonfigurationer og -objekter
• Tilladelsessystem - Nem at bruge tilladelsesstyring
• Databaseværktøjer - Skemamigrering og tabelstyringsværktøjer
• JWT Support - JSON Web Token implementering til sikker godkendelse
• Metadatagenerering - SEO og indholdsekstraktionsværktøjer
• Admin Interface - Standardiserede moduladministrationssider

XMF Komponentoversigt

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

Nøglefunktioner

Navneområder og autoindlæsning

Alle XMF-klasser findes i Xmf-navneområdet. Klasser indlæses automatisk, når der henvises til dem - der kræves ingen manual.

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

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

Sikker håndtering af anmodninger

Request class giver typesikker adgang til HTTP anmodningsdata med indbygget desinficering:

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

Modulhjælpersystem

Module Helper giver nem adgang til modulrelateret funktionalitet:

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

Tilladelsesstyring

Permission-Helper forenkler håndtering af XOOPS tilladelser:

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

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

Dokumentationsstruktur

Grundlæggende

• Kom godt i gang-med-XMF - Installation og grundlæggende brug
• XMF-Request - Forespørgselshåndtering og inputvalidering
• XMF-Module-Helper - Brug af modulhjælperklasse

Opskrifter

• Permission-Helper - Arbejde med tilladelser
• Module-Admin-Pages - Oprettelse af standardiserede admin-grænseflader

Reference

• JWT - Implementering af JSON Web Token
• Database - Databaseværktøjer og skemastyring
• Metagen - Metadata og SEO-værktøjer

Krav

• XOOPS 2.5.8 eller nyere
• PHP 7.2 eller nyere (PHP 8.x anbefales)

Installation

XMF er inkluderet med XOOPS 2.5.8 og nyere versioner. For tidligere versioner eller manuel installation:

1. Download XMF-pakken fra XOOPS-lageret
2. Udpak til din XOOPS /class/xmf/ mappe
3. Autoloaderen vil håndtere klasseindlæsning automatisk

Eksempel på hurtig start

Her er et komplet eksempel, der viser almindelige XMF-brugsmønstre:

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

Ressourcer

• XMF GitHub-lager
• XOOPS Project Website

---

#xmf #xoops #framework #php #modul-udvikling