Kerangka XMF

2.5.x ✅ 4.0.x ✅

XOOPS Module Framework (XMF) adalah perpustakaan canggih yang dirancang untuk menyederhanakan dan menstandarkan pengembangan module XOOPS. XMF menyediakan praktik PHP modern termasuk namespace, pemuatan otomatis, dan serangkaian kelas pembantu komprehensif yang mengurangi kode boilerplate dan meningkatkan kemudahan perawatan.

Apa itu XMF?

XMF adalah kumpulan kelas dan utilitas yang menyediakan:

Dukungan PHP modern - Dukungan namespace lengkap dengan pemuatan otomatis PSR-4
Penanganan Permintaan - Validasi dan sanitasi input yang aman
Pembantu module - Akses yang disederhanakan ke konfigurasi module dan objek
Sistem Izin - Manajemen izin yang mudah digunakan
Utilitas Basis Data - Migrasi skema dan alat manajemen tabel
Dukungan JWT - Implementasi Token Web JSON untuk autentikasi yang aman
Pembuatan Metadata - SEO dan utilitas ekstraksi konten
Antarmuka Admin - Halaman administrasi module standar

Ikhtisar Komponen 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

Fitur Utama

namespace dan Pemuatan Otomatis

Semua kelas XMF berada di namespace Xmf. Kelas dimuat secara otomatis saat direferensikan - tidak diperlukan manual yang disertakan.

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

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

Penanganan Permintaan Aman

Kelas Permintaan menyediakan akses aman tipe ke data permintaan HTTP dengan sanitasi bawaan:

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

Sistem Pembantu module

Module Helper menyediakan akses mudah ke fungsionalitas terkait 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');

Manajemen Izin

Permission-Helper menyederhanakan penanganan izin XOOPS:

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

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

Struktur Dokumentasi

Dasar-dasar

Memulai-dengan-XMF - Instalasi dan penggunaan dasar
XMF-Request - Penanganan permintaan dan validasi input
XMF-Module-Helper - Penggunaan kelas pembantu module

Resep

Izin-Pembantu - Bekerja dengan izin
Module-Admin-Pages - Membuat antarmuka admin standar

Referensi

JWT - Implementasi Token Web JSON
Database - Utilitas database dan manajemen skema
Metagen - Metadata dan utilitas SEO

Persyaratan

XOOPS 2.5.8 atau lebih baru
PHP 7.2 atau lebih baru (disarankan PHP 8.x)

Instalasi

XMF disertakan dengan XOOPS 2.5.8 dan versi yang lebih baru. Untuk versi sebelumnya atau instalasi manual:

Unduh paket XMF dari repositori XOOPS
Ekstrak ke direktori XOOPS /class/xmf/ Anda
Pemuat otomatis akan menangani pemuatan kelas secara otomatis

Contoh Mulai Cepat

Berikut adalah contoh lengkap yang menunjukkan pola penggunaan umum 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;
}

Sumber Daya

#xmf #xoops #framework #php #pengembangan module