Tovább a tartalomhoz

XOOPS kernel osztályok

A XOOPS Kernel biztosítja az alapvető keretrendszert a rendszer indításához, a konfigurációk kezeléséhez, a rendszeresemények kezeléséhez és az alapvető segédprogramok biztosításához. Ezek az osztályok alkotják a XOOPS alkalmazás gerincét.

graph TD
A[XoopsKernel] -->|initializes| B[Configuration Manager]
A -->|manages| C[Service Container]
A -->|handles| D[System Hooks]
A -->|registers| E[Core Services]
B -->|loads| F[config.php]
B -->|manages| G[Module Configs]
C -->|contains| H[Database]
C -->|contains| I[Logger]
C -->|contains| J[Template Engine]
C -->|contains| K[Module Manager]
E -->|registers| L[User Service]
E -->|registers| M[Module Service]
E -->|registers| N[Database Service]

A fő kernelosztály, amely inicializálja és kezeli a XOOPS rendszert.

namespace Xoops;
class XoopsKernel
{
private static ?XoopsKernel $instance = null;
protected ServiceContainer $services;
protected ConfigurationManager $config;
protected array $modules = [];
protected bool $isLoaded = false;
}
private function __construct()

A privát kivitelező egyszemélyes mintát kényszerít ki.

Lekéri a singleton kernel példányt.

public static function getInstance(): XoopsKernel

Vissza: XOOPSKernel – Az egyszemélyes kernelpéldány

Példa:

$kernel = XoopsKernel::getInstance();

A kernel rendszerindítási folyamata a következő lépéseket követi:

  1. Inicializálás - Hibakezelők beállítása, állandók meghatározása
  2. Konfiguráció - Konfigurációs fájlok betöltése
  3. Szolgáltatás regisztráció - Az alapvető szolgáltatások regisztrálása
  4. modulfelismerés - Az aktív modulok vizsgálata és azonosítása
  5. Adatbázis inicializálása - Csatlakozás az adatbázishoz
  6. Takarítás - Készüljön fel a kérések kezelésére
public function boot(): void

Példa:

$kernel = XoopsKernel::getInstance();
$kernel->boot();

Regisztrál egy szolgáltatást a szolgáltatástárolóban.

public function registerService(
string $name,
callable|object $definition
): void

Paraméterek:

ParaméterTípusLeírás
$namehúrSzolgáltatásazonosító
$definitionhívható|tárgySzervizgyár vagy példány

Példa:

$kernel->registerService('custom.handler', function($c) {
return new CustomHandler();
});

Lekér egy regisztrált szolgáltatást.

public function getService(string $name): mixed

Paraméterek:

ParaméterTípusLeírás
$namehúrSzolgáltatásazonosító

Visszaküldés: mixed – A kért szolgáltatás

Példa:

$database = $kernel->getService('database');
$logger = $kernel->getService('logger');

Ellenőrzi, hogy egy szolgáltatás regisztrálva van-e.

public function hasService(string $name): bool

Példa:

if ($kernel->hasService('cache')) {
$cache = $kernel->getService('cache');
}

Kezeli az alkalmazáskonfigurációt és a modulbeállításokat.

namespace Xoops\Core;
class ConfigurationManager
{
protected array $config = [];
protected array $defaults = [];
protected string $configPath;
}

A konfigurációt betölti fájlból vagy tömbből.

public function load(string|array $source): void

Paraméterek:

ParaméterTípusLeírás
$sourcestring|tömbKonfigurációs fájl elérési útja vagy tömbje

Példa:

$config = $kernel->getService('config');
$config->load(XOOPS_ROOT_PATH . '/include/config.php');
$config->load(['sitename' => 'My Site', 'admin_email' => 'admin@example.com']);

Lekér egy konfigurációs értéket.

public function get(string $key, mixed $default = null): mixed

Paraméterek:

ParaméterTípusLeírás
$keyhúrKonfigurációs kulcs (pont jelölés)
$defaultvegyesAlapértelmezett érték, ha nem található

Visszaküldés: mixed - Konfigurációs érték

Példa:

$siteName = $config->get('sitename');
$adminEmail = $config->get('admin.email', 'admin@example.com');

Beállít egy konfigurációs értéket.

public function set(string $key, mixed $value): void

Paraméterek:

ParaméterTípusLeírás
$keyhúrKonfigurációs kulcs
$valuevegyesKonfigurációs érték

Példa:

$config->set('sitename', 'New Site Name');
$config->set('features.cache_enabled', true);

Konfigurációt kér egy adott modulhoz.

public function getModuleConfig(
string $moduleName
): array

Paraméterek:

ParaméterTípusLeírás
$moduleNamehúrmodul könyvtár neve

Vissza: array - modul konfigurációs tömb

Példa:

$publisherConfig = $config->getModuleConfig('publisher');

A rendszerhookok lehetővé teszik a modulok és beépülő modulok számára, hogy kódot hajtsanak végre az alkalmazás életciklusának meghatározott pontjain.

namespace Xoops\Core;
class HookManager
{
protected array $hooks = [];
protected array $listeners = [];
}

Regisztrál egy hook pontot.

public function addHook(string $name): void

Paraméterek:

ParaméterTípusLeírás
$namehúrHorogazonosító

Példa:

$hooks = $kernel->getService('hooks');
$hooks->addHook('system.startup');
$hooks->addHook('user.login');
$hooks->addHook('module.install');

A hallgatót egy hookhoz rögzíti.

public function listen(
string $hookName,
callable $callback,
int $priority = 10
): void

Paraméterek:

ParaméterTípusLeírás
$hookNamehúrHorogazonosító
$callbackhívhatóA végrehajtandó függvény
$priorityintVégrehajtási prioritás (magasabb futtatások először)

Példa:

$hooks->listen('user.login', function($user) {
error_log('User ' . $user->uname . ' logged in');
}, 10);
$hooks->listen('module.install', function($module) {
// Custom module installation logic
echo "Installing " . $module->getName();
}, 5);

Kivégzi az összes hallgatót egy hookért.

public function trigger(
string $hookName,
mixed $arguments = null
): array

Paraméterek:| Paraméter | Típus | Leírás | |-----------|------|--------------| | $hookName | húr | Horogazonosító | | $arguments | vegyes | A hallgatóknak továbbítandó adatok |

Visszaküldés: array - Eredmények az összes hallgatótól

Példa:

$results = $hooks->trigger('system.startup');
$results = $hooks->trigger('user.created', $newUser);

A rendszermag számos alapvető szolgáltatást regisztrál a rendszerindítás során:

SzolgáltatásosztályCél
databaseXOOPSDatabaseAdatbázis-absztrakciós réteg
configConfigurationManagerKonfigurációkezelés
loggerLoggerAlkalmazásnaplózás
templateXOOPSTplSablon motor
userUserManagerFelhasználókezelési szolgáltatás
modulemoduleManagermodulkezelés
cacheCacheManagerGyorsítótárazási réteg
hooksHookManagerRendszeresemény-hookok
<?php
/**
* Custom module boot process utilizing kernel
*/
// Get kernel instance
$kernel = XoopsKernel::getInstance();
// Boot the system
$kernel->boot();
// Get services
$config = $kernel->getService('config');
$database = $kernel->getService('database');
$logger = $kernel->getService('logger');
$hooks = $kernel->getService('hooks');
// Access configuration
$siteName = $config->get('sitename');
$adminEmail = $config->get('admin.email');
// Register module-specific hooks
$hooks->listen('user.login', function($user) {
// Log user login
$logger->info('User login: ' . $user->uname);
// Track in database
$database->query(
'INSERT INTO ' . $database->prefix('event_log') .
' (type, user_id, message, timestamp) VALUES (?, ?, ?, ?)',
['login', $user->uid(), 'User login', time()]
);
});
$hooks->listen('module.install', function($module) {
$logger->info('Module installed: ' . $module->getName());
});
// Trigger hooks
$hooks->trigger('system.startup');
// Use database service
$result = $database->query(
'SELECT * FROM ' . $database->prefix('users') .
' LIMIT 10'
);
while ($row = $database->fetchArray($result)) {
echo "User: " . htmlspecialchars($row['uname']) . "\n";
}
// Register custom service
$kernel->registerService('custom.repository', function($c) {
return new CustomRepository($c->getService('database'));
});
// Later access custom service
$repo = $kernel->getService('custom.repository');

A rendszermag számos fontos állandót határoz meg a rendszerindítás során:

// System paths
define('XOOPS_ROOT_PATH', '/var/www/xoops');
define('XOOPS_HTDOCS_PATH', XOOPS_ROOT_PATH . '/htdocs');
define('XOOPS_MODULES_PATH', XOOPS_ROOT_PATH . '/htdocs/modules');
define('XOOPS_THEMES_PATH', XOOPS_ROOT_PATH . '/htdocs/themes');
// Web paths
define('XOOPS_URL', 'http://example.com');
define('XOOPS_HTDOCS_URL', XOOPS_URL . '/htdocs');
// Database
define('XOOPS_DB_PREFIX', 'xoops_');

A kernel hibakezelőket állít be a rendszerindítás során:

// Set custom error handler
set_error_handler(function($errno, $errstr, $errfile, $errline) {
$kernel->getService('logger')->error(
"Error: $errstr in $errfile:$errline"
);
});
// Set exception handler
set_exception_handler(function($exception) {
$kernel->getService('logger')->critical(
"Exception: " . $exception->getMessage()
);
});
  1. Egyszeri rendszerindítás – A boot()-t csak egyszer hívja az alkalmazás indításakor
  2. A Service Container használata – Regisztráljon és kérjen le szolgáltatásokat a kernelen keresztül
  3. Kezelje korai hookokat - Regisztrálja a hookhallgatókat, mielőtt elindítaná őket
  4. Fontos események naplózása – Hibakereséshez használja a naplózó szolgáltatást
  5. Gyorsítótár konfigurációja - Töltsd be egyszer a konfigurációt, és használd újra
  6. Hibakezelés - Mindig állítson be hibakezelőket a kérések feldolgozása előtt
  • ../module/module-System - modulrendszer és életciklus
  • ../Template/Template-System - Sablonmotor integráció
  • ../User/User-System - Felhasználó hitelesítés és kezelése
  • ../Database/XOOPSDatabase - Adatbázis réteg

Lásd még: XOOPS Kernelforrás