Lecteur Markdown
SYSTEM_DOCUMENTATION_EN
Feature: System #
Displays BeamReactor installation system information: engine version, PHP configuration status, list of included files and historical changelog.
---
Installation and Configuration #
Via FTP: Upload the `system/` directory into `/plugins/`.
Via package manager: Select `system` from the available plugins list.
Paths:
- Main plugin: `/plugins/system/system.php`
- Configuration: `/plugins/system/conf/system.conf.inc.php`
- Library: `/plugins/system/lib/system.lib.inc.php`
- Handler: `/plugins/system/handlers/system.mod.php`
- Locales: `/plugins/system/locale/`
Configuration parameters (`system.conf.inc.php`):
| Variable | Default | Description |
|---|---|---|
| `$basedatadisplay` | `'yes'` | Display in management interface |
| `$basedisplevel` | `BASE_LEVEL_MODERATOR` | Minimum required level |
| `$ftype` | `3` | Plugin type (system) |
| `HIST` | `ROOT_DIR/$cfg[20]/hist.txt` | Log file path |
---
Usage #
The plugin is organised into tabs (jQuery UI):
- About: engine version (read from `@version` in `index.php`), build date, active PHP extensions, `register_globals` status.
- History: contents of `var/hist.txt` file, most recent entries first.
- Included files: list of PHP files loaded for the current page.
Required levels:
- Read: `BASE_LEVEL_MODERATOR`
- Add log entry: `BASE_LEVEL_ADMIN`
---
Hooks and Entry Points #
?obj=system.mod&act=about — Display system information
?obj=system.mod&act=hist — Display and manage the history log
---
Dependencies #
- File access on `var/hist.txt` (write required for additions)
- Regex parsing of `@version` and `@date` tags in `index.php`
- jQuery UI (tabs) — included in the BeamReactor core