XMF Рамка

2.5.x ✅ 4.0.x ✅

XOOPS Module Framework (XMF) — це потужна бібліотека, призначена для спрощення та стандартизації розробки модулів XOOPS. XMF надає сучасні методи PHP, включаючи простори імен, автозавантаження та повний набір допоміжних класів, які зменшують шаблонний код і покращують обслуговування.

Що таке XMF?

XMF – це набір класів і утиліт, які забезпечують:

Сучасна підтримка PHP - Повна підтримка простору імен із автозавантаженням PSR-4
Обробка запитів - Безпечна перевірка та дезінфекція введених даних
Допоміжні модулі - спрощений доступ до конфігурацій модулів і об’єктів
Система дозволів - Просте у використанні керування дозволами
Утиліти бази даних - інструменти міграції схем і керування таблицями
JWT Підтримка - JSON Реалізація веб-токена для безпечної автентифікації
Генерація метаданих - SEO та утиліти вилучення вмісту
Інтерфейс адміністратора - Стандартизовані сторінки адміністрування модуля### 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

Ключові характеристики

Простори імен і автозавантаження

Усі класи XMF знаходяться в просторі імен XMF. Класи завантажуються автоматично при посиланні - не потрібно включати посібник.

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

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

Безпечна обробка запитів

Клас запиту забезпечує типобезпечний доступ до даних запиту HTTP із вбудованою обробкою:

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

Допоміжна система модуля

[Module Helper] (../05-XMF-Framework/Basics/XMF-Module-Helper.md) забезпечує зручний доступ до функцій, пов’язаних із модулями:

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

Керування дозволами

Permission-Helper спрощує XOOPS обробку дозволів:

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

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

Структура документації

Основи

Початок роботи з-XMF - Встановлення та базове використання
XMF-Запит - Обробка запитів і перевірка введених даних
XMF-Module-Helper - Використання допоміжного класу модуля

Рецепти

Permission-Helper - Робота з дозволами
Module-Admin-Pages - Створення стандартизованих інтерфейсів адміністратора

Довідка

JWT - Реалізація веб-токена JSON
База даних - Утиліти бази даних і керування схемою
Metagen - Метадані та SEO утиліти

Вимоги

XOOPS 2.5.8 або новіша версія
PHP 7.2 або пізнішої версії (PHP 8.x рекомендовано)

Встановлення

XMF входить до XOOPS 2.5.8 і пізніших версій. Для попередніх версій або встановлення вручну:

Завантажте пакет XMF з репозиторію XOOPS
Витягніть у свій каталог XOOPS /class/XMF/
Автозавантажувач автоматично оброблятиме завантаження класу

Приклад швидкого запускуОсь повний приклад, що демонструє загальні шаблони використання 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;
}

Ресурси

#XMF #XOOPS #framework #php #module-development