Gå til indhold

XOOPS Kernel Classes

XOOPS-kernen giver den grundlæggende ramme for bootstrapping af systemet, styring af konfigurationer, håndtering af systemhændelser og levering af kerneværktøjer. Disse klasser udgør rygraden i XOOPS-applikationen.

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]

Hovedkerneklassen, der initialiserer og administrerer XOOPS-systemet.

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()

Privat konstruktør håndhæver singleton-mønster.

Henter singleton-kerneinstansen.

public static function getInstance(): XoopsKernel

Returnerer: XoopsKernel - Singleton-kerneinstansen

Eksempel:

$kernel = XoopsKernel::getInstance();

Kernen boot processen følger disse trin:

  1. Initialisering - Indstil fejlbehandlere, definer konstanter
  2. Konfiguration - Indlæs konfigurationsfiler
  3. Tjenesteregistrering - Registrer kerneydelser
  4. Moduledetektion - Scan og identificer aktive moduler
  5. Databaseinitialisering - Opret forbindelse til databasen
  6. Oprydning - Forbered dig på håndtering af anmodninger
public function boot(): void

Eksempel:

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

Registrerer en service i servicecontaineren.

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

Parametre:

ParameterSkrivBeskrivelse
$namestrengTjeneste-id
$definitioncallable|objektServicefabrik eller instans

Eksempel:

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

Henter en registreret tjeneste.

public function getService(string $name): mixed

Parametre:

ParameterSkrivBeskrivelse
$namestrengTjeneste-id

Returneringer: mixed - Den ønskede tjeneste

Eksempel:

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

Tjek om en tjeneste er registreret.

public function hasService(string $name): bool

Eksempel:

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

Administrerer applikationskonfiguration og modulindstillinger.

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

Indlæser konfiguration fra fil eller array.

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

Parametre:

ParameterSkrivBeskrivelse
$sourcestreng|arrayKonfigurationsfilsti eller array

Eksempel:

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

Henter en konfigurationsværdi.

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

Parametre:

ParameterSkrivBeskrivelse
$keystrengKonfigurationsnøgle (punktnotation)
$defaultblandetStandardværdi, hvis den ikke findes

Returneringer: mixed - Konfigurationsværdi

Eksempel:

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

Indstiller en konfigurationsværdi.

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

Parametre:

ParameterSkrivBeskrivelse
$keystrengKonfigurationsnøgle
$valueblandetKonfigurationsværdi

Eksempel:

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

Får konfiguration til et specifikt modul.

public function getModuleConfig(
string $moduleName
): array

Parametre:

ParameterSkrivBeskrivelse
$moduleNamestrengModulkatalognavn

Returneringer: array - Modulkonfigurationsarray

Eksempel:

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

Systemhooks tillader moduler og plugins at udføre kode på bestemte punkter i applikationens livscyklus.

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

Registrerer et krogpunkt.

public function addHook(string $name): void

Parametre:

ParameterSkrivBeskrivelse
$namestrengKrog identifikator

Eksempel:

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

Fastgør en lytter til en krog.

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

Parametre:

ParameterSkrivBeskrivelse
$hookNamestrengKrog identifikator
$callbackopkaldbarFunktion til at udføre
$priorityintUdførelsesprioritet (højere kørsler først)

Eksempel:

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

Henretter alle lyttere for en hook.

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

Parametre:| Parameter | Skriv | Beskrivelse | |-----------|------|------------| | $hookName | streng | Krog identifikator | | $arguments | blandet | Data, der skal videregives til lyttere |

Returneringer: array - Resultater fra alle lyttere

Eksempel:

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

Kernen registrerer flere kernetjenester under opstart:

ServiceKlasseFormål
databaseXoopsDatabaseDatabaseabstraktionslag
configConfigurationManagerKonfigurationsstyring
loggerLoggerAnsøgningslogning
templateXoopsTplSkabelonmotor
userUserManagerBrugeradministrationstjeneste
moduleModuleManagerModulstyring
cacheCacheManagerCachinglag
hooksHookManagerSystem event hooks
<?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');

Kernen definerer flere vigtige konstanter under opstart:

// 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_');

Kernen opsætter fejlbehandlere under opstart:

// 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. Enkeltstart - Ring kun til boot() én gang under opstart af programmet
  2. Brug Service Container - Registrer og hent tjenester gennem kernen
  3. Håndter kroge tidligt - Registrer hooklyttere, før du udløser dem
  4. Log vigtige begivenheder - Brug loggertjenesten til fejlretning
  5. Cachekonfiguration - Indlæs konfiguration én gang og genbrug
  6. Fejlhåndtering - Opsæt altid fejlbehandlere, før du behandler anmodninger
  • ../Module/Module-System - Modulsystem og livscyklus
  • ../Template/Template-System - Integration af skabelonmotor
  • ../User/User-System - Brugergodkendelse og administration
  • ../Database/XoopsDatabase - Databaselag

Se også: XOOPS Kernel Source