Framework XMF

2.5.x ✅ 4.0.x ✅

Le XOOPS Module Framework (XMF) est une bibliothèque puissante conçue pour simplifier et standardiser le développement des modules XOOPS. XMF fournit les pratiques PHP modernes, notamment les espaces de noms, le chargement automatique et un ensemble complet de classes d’aide qui réduisent le code passe-partout et améliorent la maintenabilité.

Qu’est-ce que XMF?

XMF est une collection de classes et d’utilitaires qui offrent:

Support PHP moderne - Support complet des espaces de noms avec chargement automatique PSR-4
Gestion des requêtes - Validation et assainissement sécurisés des entrées
Aides de module - Accès simplifié aux configurations et objets du module
Système de permissions - Gestion facile des permissions
Utilitaires de base de données - Outils de migration de schéma et de gestion de table
Support JWT - Implémentation JSON Web Token pour l’authentification sécurisée
Génération de métadonnées - Utilitaires SEO et d’extraction de contenu
Interface d’administration - Pages d’administration standardisées du module

Aperçu des composants 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

Fonctionnalités principales

Espaces de noms et chargement automatique

Toutes les classes XMF résident dans l’espace de noms Xmf. Les classes sont chargées automatiquement lorsqu’elles sont référencées - aucune inclusion manuelle requise.

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

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

Gestion sécurisée des requêtes

La classe Request fournit un accès de type sûr aux données de requête HTTP avec assainissement intégré:

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

Système d’aide du module

L’aide du module fournit un accès facile à la fonctionnalité du 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');

Gestion des permissions

L’aide de permission simplifie la gestion des permissions XOOPS:

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

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

Structure de la documentation

Bases

Getting-Started-with-XMF - Installation et utilisation de base
XMF-Request - Gestion des requêtes et validation des entrées
XMF-Module-Helper - Utilisation de la classe d’aide du module

Recettes

Permission-Helper - Travailler avec les permissions
Module-Admin-Pages - Création d’interfaces d’administration standardisées

Référence

JWT - Implémentation JSON Web Token
Database - Utilitaires de base de données et gestion de schéma
Metagen - Utilitaires de métadonnées et SEO

Exigences

XOOPS 2.5.8 ou version ultérieure
PHP 7.2 ou version ultérieure (PHP 8.x recommandé)

Installation

XMF est inclus avec XOOPS 2.5.8 et les versions ultérieures. Pour les versions antérieures ou l’installation manuelle:

Téléchargez le package XMF depuis le dépôt XOOPS
Extrayez dans votre répertoire /class/xmf/ XOOPS
Le chargeur automatique gère le chargement de classe automatiquement

Exemple de démarrage rapide

Voici un exemple complet montrant les modèles d’utilisation courants de 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;
}

Ressources

#xmf #xoops #framework #php #développement-module