Skip to content
XOOPS 2.7 Docs

XMF Rangka Kerja

2.5.x ✅ 4.0.x ✅

XOOPS Rangka Kerja Modul (XMF) ialah perpustakaan berkuasa yang direka untuk memudahkan dan menyeragamkan pembangunan modul XOOPS. XMF menyediakan amalan PHP moden termasuk ruang nama, autoloading dan set komprehensif kelas pembantu yang mengurangkan kod plat dandang dan meningkatkan kebolehselenggaraan.

Apakah itu XMF?

Section titled “Apakah itu XMF?”

XMF ialah koleksi kelas dan utiliti yang menyediakan:

  • Sokongan PHP Moden - Sokongan ruang nama penuh dengan pemuatan automatik PSR-4
  • Pengendalian Permintaan - Pengesahan dan sanitasi input selamat
  • Pembantu Modul - Akses mudah kepada konfigurasi modul dan objek
  • Sistem Kebenaran - Pengurusan kebenaran yang mudah digunakan
  • Utiliti Pangkalan Data - Penghijrahan skema dan alatan pengurusan jadual
  • JWT Sokongan - JSON Pelaksanaan Token Web untuk pengesahan selamat
  • Penjanaan Metadata - SEO dan utiliti pengekstrakan kandungan
  • Antara Muka Pentadbiran - Halaman pentadbiran modul standard### XMF Gambaran Keseluruhan Komponen
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

Ciri Utama

Section titled “Ciri Utama”

Ruang nama dan Automuat

Section titled “Ruang nama dan Automuat”

Semua XMF kelas berada dalam ruang nama XMF. Kelas dimuatkan secara automatik apabila dirujuk - tiada manual termasuk diperlukan.

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


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

Pengendalian Permintaan Selamat

Section titled “Pengendalian Permintaan Selamat”

Kelas Permintaan menyediakan akses selamat jenis kepada data permintaan HTTP dengan sanitasi terbina dalam:

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 Modul

Section titled “Sistem Pembantu Modul”

Module Helper menyediakan akses mudah kepada kefungsian berkaitan modul:

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

Pengurusan Kebenaran

Section titled “Pengurusan Kebenaran”

Permission-Helper memudahkan XOOPS pengendalian kebenaran:

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


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

Struktur Dokumentasi

Section titled “Struktur Dokumentasi”

Asas

Section titled “Asas”

Resipi

Section titled “Resipi”

Rujukan

Section titled “Rujukan”
  • JWT - JSON pelaksanaan Token Web
  • Pangkalan Data - Utiliti pangkalan data dan pengurusan skema
  • Metagen - Metadata dan SEO utiliti

Keperluan

Section titled “Keperluan”
  • XOOPS 2.5.8 atau lebih baru
  • PHP 7.2 atau lebih baru (PHP 8.x disyorkan)

Pemasangan

Section titled “Pemasangan”

XMF disertakan dengan XOOPS 2.5.8 dan versi yang lebih baru. Untuk versi terdahulu atau pemasangan manual:

  1. Muat turun pakej XMF daripada repositori XOOPS
  2. Ekstrak ke direktori XOOPS /class/XMF/ anda
  3. Autoloader akan mengendalikan pemuatan kelas secara automatik

Contoh Mula PantasBerikut ialah contoh lengkap yang menunjukkan corak penggunaan biasa XMF:

Section titled “Contoh Mula PantasBerikut ialah contoh lengkap yang menunjukkan corak penggunaan biasa 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

Section titled “Sumber”

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