Framework XMF

2.5.x ✅ 4.0.x ✅

L’XOOPS Module Framework (XMF) è una libreria potente progettata per semplificare e standardizzare lo sviluppo di moduli XOOPS. XMF fornisce pratiche PHP moderne inclusi namespace, autoloading e un set completo di classi helper che riducono il codice boilerplate e migliorano la manutenibilità.

Cos’è XMF?

XMF è una collezione di classi e utilità che forniscono:

Supporto PHP Moderno - Pieno supporto per namespace con autoloading PSR-4
Gestione delle Richieste - Validazione e sanitizzazione sicure dell’input
Module Helper - Accesso semplificato alle configurazioni e agli oggetti del modulo
Sistema di Permessi - Gestione facile dei permessi
Utilità di Database - Strumenti per migrazioni di schema e gestione delle tabelle
Supporto JWT - Implementazione di JSON Web Token per l’autenticazione sicura
Generazione di Metadati - Utilità per SEO ed estrazione di contenuti
Interfaccia Admin - Pagine di amministrazione standardizzate per i moduli

Panoramica dei Componenti 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

Caratteristiche Principali

Namespace e Autoloading

Tutte le classi XMF si trovano nello spazio dei nomi Xmf. Le classi vengono caricate automaticamente quando referenziate - non sono richiesti include manuali.

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

// Le classi si caricano automaticamente quando utilizzate
$input = Request::getString('input', '');
$helper = Helper::getHelper('mymodule');

Gestione Sicura delle Richieste

La classe Request fornisce accesso type-safe ai dati delle richieste HTTP con sanitizzazione integrata:

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

Sistema Module Helper

L’Module Helper fornisce accesso conveniente alle funzionalità relative al modulo:

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

// Accedi alla configurazione del modulo
$configValue = $helper->getConfig('setting_name', 'default');

// Ottieni l'oggetto del modulo
$module = $helper->getModule();

// Accedi agli handler
$handler = $helper->getHandler('items');

Gestione dei Permessi

L’Permission-Helper semplifica la gestione dei permessi XOOPS:

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

// Controlla il permesso dell'utente
if ($permHelper->checkPermission('view', $itemId)) {
    // L'utente ha il permesso
}

Struttura della Documentazione

Fondamenti

Getting-Started-with-XMF - Installazione e utilizzo di base
XMF-Request - Gestione delle richieste e validazione dell’input
XMF-Module-Helper - Uso della classe module helper

Ricette

Permission-Helper - Lavoro con i permessi
Module-Admin-Pages - Creazione di interfacce di amministrazione standardizzate

Riferimento

JWT - Implementazione di JSON Web Token
Database - Utilità di database e gestione dello schema
Metagen - Utilità di metadati e SEO

Requisiti

XOOPS 2.5.8 o successivo
PHP 7.2 o successivo (PHP 8.x consigliato)

Installazione

XMF è incluso con XOOPS 2.5.8 e versioni successive. Per versioni precedenti o installazione manuale:

Scarica il pacchetto XMF dal repository XOOPS
Estrai nella cartella /class/xmf/ di XOOPS
L’autoloader gestirà automaticamente il caricamento delle classi

Esempio di Avvio Rapido

Ecco un esempio completo che mostra i modelli di utilizzo comune di XMF:

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

// Ottieni l'helper del modulo
$helper = Helper::getHelper('mymodule');

// Ottieni i valori di configurazione
$itemsPerPage = $helper->getConfig('items_per_page', 10);

// Gestisci l'input della richiesta
$op = Request::getCmd('op', 'list');
$id = Request::getInt('id', 0);

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

// Elabora in base all'operazione
switch ($op) {
    case 'view':
        $handler = $helper->getHandler('items');
        $item = $handler->get($id);
        // ... visualizza l'elemento
        break;
    case 'list':
    default:
        // ... elenca gli elementi
        break;
}

Risorse

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