# helphp-inrai/helphp architecture

> Architecture diagram of the GitHub repository helphp-inrai/helphp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/helphp-inrai/helphp
- Repository: https://github.com/helphp-inrai/helphp
- Video tour (about a minute): https://gitdiagram.com/helphp-inrai/helphp/video

## Overview

HelPHP is a PHP/JavaScript toolkit and modular multilingual web-application platform, not a framework. A typical user-facing path is through ready-made editing and management modules, which use shared PHP libraries and UI helpers to render and manage application data. The repository also includes media handling, search, preview, translation, user/group management, and administration capabilities. Relationships below follow excerpted code and SOURCE INDEX references; several listed modules were not sampled, so their internal wiring is not asserted.

Main entry points: [`libs/HelPHP_module.php`](https://github.com/helphp-inrai/helphp/blob/main/libs/HelPHP_module.php) (Module base), [`modules/document/admin/Document.php`](https://github.com/helphp-inrai/helphp/blob/main/modules/document/admin/Document.php) (Document editing), [`libs/H.php`](https://github.com/helphp-inrai/helphp/blob/main/libs/H.php) (HTML builder), [`modules/blockeditor/admin/Blockeditor.php`](https://github.com/helphp-inrai/helphp/blob/main/modules/blockeditor/admin/Blockeditor.php) (Block editor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_modules["Application modules"]
  node_config["Configuration admin<br/>[Config.php]"]
  node_blockedit["Block editor<br/>[Blockeditor.php]"]
  node_documents["Document editing<br/>[Document.php]"]
  node_category["Category management<br/>[Category.php]"]
  node_groups["Group management<br/>[Group.php]"]
  node_hierarchy["Hierarchy management<br/>[Hierarchy.php]"]
  node_users["User management<br/>[Users.php]"]
  node_preview["Content preview<br/>[Preview.php]"]
  node_indexation["Search indexing<br/>[Indexation.php]"]
  node_search["Public search<br/>[Search.php]"]
  node_mediaadmin["Media management<br/>[Media.php]"]
end

subgraph group_foundation["PHP foundation"]
  node_database["Database access<br/>[DB.php]"]
  node_modulebase["Module base<br/>[HelPHP_module.php]"]
  node_html["HTML builder<br/>[H.php]"]
  node_utils["Shared utilities<br/>[Utils.php]"]
end

subgraph group_content["Content services"]
  node_languages["Language services<br/>[Language.php]"]
  node_media["Media processing<br/>[Media.php]"]
  node_filesystem["File operations<br/>[Filesystem.php]"]
end

subgraph group_interface["Browser interface"]
  node_ui["Browser UI runtime<br/>[ui.js]"]
end

node_user(("Application user"))

node_user -.->|"edits content"| node_documents
node_user -.->|"searches content"| node_search
node_blockedit -->|"renders with"| node_html
node_blockedit -->|"uses base"| node_modulebase
node_documents -->|"uses base"| node_modulebase
node_documents -->|"references"| node_indexation
node_documents -->|"references"| node_preview
node_documents -.->|"uses categories"| node_category
node_category -->|"uses base"| node_modulebase
node_groups -->|"uses base"| node_modulebase
node_hierarchy -->|"references"| node_groups
node_hierarchy -->|"references"| node_mediaadmin
node_users -->|"uses base"| node_modulebase
node_preview -->|"uses base"| node_modulebase
node_preview -.->|"creates instance"| node_ui
node_indexation -->|"uses base"| node_modulebase
node_search -->|"uses base"| node_modulebase
node_mediaadmin -->|"uses base"| node_modulebase
node_mediaadmin -->|"uses media"| node_media
node_media -->|"uses files"| node_filesystem
node_media -->|"uses language"| node_languages
node_modulebase -->|"translates text"| node_languages
node_languages -.->|"calls translation service"| node_user
node_blockedit -->|"uses builder"| node_html
node_html -->|"loads runtime"| node_ui
node_documents -->|"renders with"| node_html
node_config -->|"uses base"| node_modulebase
node_config -->|"writes config"| node_utils
node_database -->|"references"| node_utils
node_modulebase -->|"uses utilities"| node_utils
node_html -->|"references module"| node_documents

click node_config "https://github.com/helphp-inrai/helphp/blob/main/modules/config/admin/Config.php"
click node_blockedit "https://github.com/helphp-inrai/helphp/blob/main/modules/blockeditor/admin/Blockeditor.php"
click node_documents "https://github.com/helphp-inrai/helphp/blob/main/modules/document/admin/Document.php"
click node_category "https://github.com/helphp-inrai/helphp/blob/main/modules/category/admin/Category.php"
click node_groups "https://github.com/helphp-inrai/helphp/blob/main/modules/group/admin/Group.php"
click node_hierarchy "https://github.com/helphp-inrai/helphp/blob/main/modules/hierarchy/admin/Hierarchy.php"
click node_users "https://github.com/helphp-inrai/helphp/blob/main/modules/users/admin/Users.php"
click node_preview "https://github.com/helphp-inrai/helphp/blob/main/modules/preview/admin/Preview.php"
click node_indexation "https://github.com/helphp-inrai/helphp/blob/main/modules/indexation/admin/Indexation.php"
click node_search "https://github.com/helphp-inrai/helphp/blob/main/modules/search/public/Search.php"
click node_mediaadmin "https://github.com/helphp-inrai/helphp/blob/main/modules/media/admin/Media.php"
click node_database "https://github.com/helphp-inrai/helphp/blob/main/libs/DB.php"
click node_modulebase "https://github.com/helphp-inrai/helphp/blob/main/libs/HelPHP_module.php"
click node_html "https://github.com/helphp-inrai/helphp/blob/main/libs/H.php"
click node_utils "https://github.com/helphp-inrai/helphp/blob/main/libs/Utils.php"
click node_languages "https://github.com/helphp-inrai/helphp/blob/main/libs/Language.php"
click node_media "https://github.com/helphp-inrai/helphp/blob/main/libs/Media.php"
click node_filesystem "https://github.com/helphp-inrai/helphp/blob/main/libs/Filesystem.php"
click node_ui "https://github.com/helphp-inrai/helphp/blob/main/js/ui.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_config,node_blockedit,node_documents,node_category,node_groups,node_hierarchy,node_users,node_preview,node_indexation,node_search,node_mediaadmin,node_user toneBlue
class node_database,node_modulebase,node_html,node_utils toneAmber
class node_languages,node_media,node_filesystem toneMint
class node_ui toneRose
```

## Components

### Application modules

- [Configuration admin](https://github.com/helphp-inrai/helphp/blob/main/modules/config/admin/Config.php): `modules/config/admin/Config.php`
- [Block editor](https://github.com/helphp-inrai/helphp/blob/main/modules/blockeditor/admin/Blockeditor.php): `modules/blockeditor/admin/Blockeditor.php`
- [Document editing](https://github.com/helphp-inrai/helphp/blob/main/modules/document/admin/Document.php): `modules/document/admin/Document.php`
- [Category management](https://github.com/helphp-inrai/helphp/blob/main/modules/category/admin/Category.php): `modules/category/admin/Category.php`
- [Group management](https://github.com/helphp-inrai/helphp/blob/main/modules/group/admin/Group.php): `modules/group/admin/Group.php`
- [Hierarchy management](https://github.com/helphp-inrai/helphp/blob/main/modules/hierarchy/admin/Hierarchy.php): `modules/hierarchy/admin/Hierarchy.php`
- [User management](https://github.com/helphp-inrai/helphp/blob/main/modules/users/admin/Users.php): `modules/users/admin/Users.php`
- [Content preview](https://github.com/helphp-inrai/helphp/blob/main/modules/preview/admin/Preview.php): `modules/preview/admin/Preview.php`
- [Search indexing](https://github.com/helphp-inrai/helphp/blob/main/modules/indexation/admin/Indexation.php): `modules/indexation/admin/Indexation.php`
- [Public search](https://github.com/helphp-inrai/helphp/blob/main/modules/search/public/Search.php): `modules/search/public/Search.php`
- [Media management](https://github.com/helphp-inrai/helphp/blob/main/modules/media/admin/Media.php): `modules/media/admin/Media.php`

### PHP foundation

- [Database access](https://github.com/helphp-inrai/helphp/blob/main/libs/DB.php): `libs/DB.php`
- [Module base](https://github.com/helphp-inrai/helphp/blob/main/libs/HelPHP_module.php): `libs/HelPHP_module.php`
- [HTML builder](https://github.com/helphp-inrai/helphp/blob/main/libs/H.php): `libs/H.php`
- [Shared utilities](https://github.com/helphp-inrai/helphp/blob/main/libs/Utils.php): `libs/Utils.php`

### Content services

- [Language services](https://github.com/helphp-inrai/helphp/blob/main/libs/Language.php): `libs/Language.php`
- [Media processing](https://github.com/helphp-inrai/helphp/blob/main/libs/Media.php): `libs/Media.php`
- [File operations](https://github.com/helphp-inrai/helphp/blob/main/libs/Filesystem.php): `libs/Filesystem.php`

### Browser interface

- [Browser UI runtime](https://github.com/helphp-inrai/helphp/blob/main/js/ui.js): `js/ui.js`

### Other components

- **Application user**

## Connections

- Application user → Document editing: edits content
- Application user → Public search: searches content
- Block editor → HTML builder: renders with (evidence: `modules/blockeditor/admin/Blockeditor.php`)
- Block editor → Module base: uses base (evidence: `modules/blockeditor/admin/Blockeditor.php`)
- Document editing → Module base: uses base (evidence: `modules/document/admin/Document.php`)
- Document editing → Search indexing: references (evidence: `modules/document/admin/Document.php`)
- Document editing → Content preview: references (evidence: `modules/document/admin/Document.php`)
- Document editing → Category management: uses categories
- Category management → Module base: uses base (evidence: `modules/category/admin/Category.php`)
- Group management → Module base: uses base (evidence: `modules/group/admin/Group.php`)
- Hierarchy management → Group management: references (evidence: `modules/hierarchy/admin/Hierarchy.php`)
- Hierarchy management → Media management: references (evidence: `modules/hierarchy/admin/Hierarchy.php`)
- User management → Module base: uses base (evidence: `modules/users/admin/Users.php`)
- Content preview → Module base: uses base (evidence: `modules/preview/admin/Preview.php`)
- Content preview → Browser UI runtime: creates instance
- Search indexing → Module base: uses base (evidence: `modules/indexation/admin/Indexation.php`)
- Public search → Module base: uses base (evidence: `modules/search/public/Search.php`)
- Media management → Module base: uses base (evidence: `modules/media/admin/Media.php`)
- Media management → Media processing: uses media (evidence: `modules/media/admin/Media.php`)
- Media processing → File operations: uses files (evidence: `libs/Media.php`)
- Media processing → Language services: uses language (evidence: `libs/Media.php`)
- Module base → Language services: translates text (evidence: `libs/HelPHP_module.php`)
- Language services → Application user: calls translation service (evidence: `libs/Language.php`)
- Block editor → HTML builder: uses builder (evidence: `modules/blockeditor/admin/Blockeditor.php`)
- HTML builder → Browser UI runtime: loads runtime (evidence: `libs/H.php`)
- Document editing → HTML builder: renders with (evidence: `modules/document/admin/Document.php`)
- Configuration admin → Module base: uses base (evidence: `modules/config/admin/Config.php`)
- Configuration admin → Shared utilities: writes config (evidence: `modules/config/admin/Config.php`)
- Database access → Shared utilities: references (evidence: `libs/DB.php`)
- Module base → Shared utilities: uses utilities (evidence: `libs/HelPHP_module.php`)
- HTML builder → Document editing: references module (evidence: `libs/H.php`)
