# e-collectivites/pleiade-custom-modules architecture

> Architecture diagram of the GitHub repository e-collectivites/pleiade-custom-modules, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/e-collectivites/pleiade-custom-modules
- Repository: https://github.com/e-collectivites/pleiade-custom-modules

## Overview

##### Project type and purpose
- This is a set of custom Drupal modules (a plugin-based architecture) built to extend the Pléiade Virtual Dashboard.
- The core “module_api_pleiade” provides a common API manager and must be enabled first.
- api_lemon_pleiade is the first connector to LL:NG endpoints, then a series of modules each connect to an external application (GLPI, HumHub, Moodle, Nextcloud, Parapheur, Pastell, Zimbra, etc.).
- Several utility modules (datatable_pleiade, guide_utilisateur_pleiade, module_actu_pleiade, module_general_pleiade, module_postit_pleiade, msg_informatif_pleiade, notification_module_pleiade, accessibility_tools) supply UI widgets, blocks, alerts, and styling.

##### File structure
- Top-level directories: one folder per custom module, each containing:
– info.yml (Drupal metadata)
– libraries.yml (CSS/JS grouping)
– routing.yml (Symfony routes → controllers)
– module_name.module (hook implementations)
– src/Controller (PHP controllers for AJAX and page callbacks)
– src/Form (configuration forms)
– css & js (frontend assets; often jQuery, DataTables, Moment.js)
– optional config/install (default settings)
- module_api_pleiade sits at the center: it exports an ApiPleiadeManager class used by all connectors.
- Each connector module uses Drupal’s MVC (Controller + Form + Block plugin) pattern.

##### Additional insights from README
- Installation order: module_api_pleiade → api_lemon_pleiade → other connectors.
- Configuration: each connector exposes a settings page (via Form classes) where endpoints and credentials for the external service are entered.
- The modules render blocks, pages, or menus in the dashboard, pulling data from external APIs through the shared API manager.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Nodes
    Browser["Browser / End-user UI"]:::browser
    DrupalCore["Drupal Core\n(Symfony Routing & Twig)"]:::core

    subgraph "Custom Modules"
        subgraph "Core Module"
            APIManager["module_api_pleiade\n(ApiPleiadeManager)"]:::coremgr
        end
        subgraph "Connectors"
            Lemon["api_lemon_pleiade"]:::connector
            GLPI["api_glpi_pleiade"]:::connector
            HumHub["api_humhub_pleiade"]:::connector
            Moodle["api_moodle_pleiade"]:::connector
            Nextcloud["api_nextcloud_pleiade"]:::connector
            Parapheur["api_parapheur_pleiade"]:::connector
            Pastell["api_pastell_pleiade"]:::connector
            UserDir["api_user_pleiade"]:::connector
            Zimbra["api_zimbra_pleiade"]:::connector
        end
        subgraph "Utilities"
            DataTable["datatable_pleiade"]:::utility
            UserGuide["guide_utilisateur_pleiade"]:::utility
            Actu["module_actu_pleiade"]:::utility
            General["module_general_pleiade"]:::utility
            PostIt["module_postit_pleiade"]:::utility
            MsgInfo["msg_informatif_pleiade"]:::utility
            Notification["notification_module_pleiade"]:::utility
            Accessibility["accessibility_tools"]:::utility
        end
    end

    Database["Database\n(MySQL/PostgreSQL)"]:::database
    ExternalAPIs["External Services / APIs\n(LL:NG, GLPI, HumHub, Moodle,\nNextcloud, Parapheur, Pastell, Zimbra)"]:::external

    %% Connections
    Browser -->|HTTP Request/Response| DrupalCore
    DrupalCore -->|loads modules| APIManager
    DrupalCore -->|loads modules| Lemon
    DrupalCore -->|loads modules| GLPI
    DrupalCore -->|loads modules| HumHub
    DrupalCore -->|loads modules| Moodle
    DrupalCore -->|loads modules| Nextcloud
    DrupalCore -->|loads modules| Parapheur
    DrupalCore -->|loads modules| Pastell
    DrupalCore -->|loads modules| UserDir
    DrupalCore -->|loads modules| Zimbra
    DrupalCore -->|loads modules| DataTable
    DrupalCore -->|loads modules| UserGuide
    DrupalCore -->|loads modules| Actu
    DrupalCore -->|loads modules| General
    DrupalCore -->|loads modules| PostIt
    DrupalCore -->|loads modules| MsgInfo
    DrupalCore -->|loads modules| Notification
    DrupalCore -->|loads modules| Accessibility

    %% Module interactions
    Lemon -->|uses ApiPleiadeManager| APIManager
    GLPI -->|uses ApiPleiadeManager| APIManager
    HumHub -->|uses ApiPleiadeManager| APIManager
    Moodle -->|uses ApiPleiadeManager| APIManager
    Nextcloud -->|uses ApiPleiadeManager| APIManager
    Parapheur -->|uses ApiPleiadeManager| APIManager
    Pastell -->|uses ApiPleiadeManager| APIManager
    UserDir -->|uses ApiPleiadeManager| APIManager
    Zimbra -->|uses ApiPleiadeManager| APIManager

    %% Data flows
    APIManager -->|REST Calls| ExternalAPIs
    APIManager -->|cache/read-write| Database
    Lemon -->|read/write| Database
    GLPI -->|read/write| Database
    HumHub -->|read/write| Database
    Moodle -->|read/write| Database
    Nextcloud -->|read/write| Database
    Parapheur -->|read/write| Database
    Pastell -->|read/write| Database
    UserDir -->|read/write| Database
    Zimbra -->|read/write| Database

    %% Click Events
    click APIManager "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/module_api_pleiade/src/ApiPleiadeManager.php"
    click Lemon "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_lemon_pleiade/src/Controller/PleiadeAjaxController.php"
    click GLPI "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_glpi_pleiade/src/Controller/GlpiController.php"
    click HumHub "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_humhub_pleiade/src/Controller/humHubController.php"
    click Moodle "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_moodle_pleiade/src/Controller/MoodleController.php"
    click Nextcloud "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_nextcloud_pleiade/src/Controller/NextcloudController.php"
    click Parapheur "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_parapheur_pleiade/src/Controller/PleiadeAjaxParapheurController.php"
    click Pastell "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_pastell_pleiade/src/Controller/PleiadeAjaxPastellController.php"
    click UserDir "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_user_pleiade/src/Controller/PleiadeUserController.php"
    click Zimbra "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/api_zimbra_pleiade/src/Controller/PleiadeAjaxZimbraController.php"
    click DataTable "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/datatable_pleiade/src/Controller/DatatableController.php"
    click UserGuide "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/guide_utilisateur_pleiade/src/Controller/UserGuideController.php"
    click Actu "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/module_actu_pleiade/src/Controller/ActuPleiadeController.php"
    click General "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/module_general_pleiade/src/Form/ModuleGeneralPleiadeConfigForm.php"
    click PostIt "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/module_postit_pleiade/src/Controller/PostItController.php"
    click MsgInfo "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/msg_informatif_pleiade/src/Controller/AlerteModuleController.php"
    click Notification "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/notification_module_pleiade/src/Controller/NotificationModuleController.php"
    click Accessibility "https://github.com/e-collectivites/pleiade-custom-modules/blob/main/accessibility_tools/src/Plugin/Block/AccessibilityToolsBlock.php"

    %% Styles
    classDef browser fill:#f9f,stroke:#333,stroke-width:1px
    classDef core fill:#bbf,stroke:#333,stroke-width:1px
    classDef coremgr fill:#8fb,stroke:#333,stroke-width:1px
    classDef connector fill:#fb8,stroke:#333,stroke-width:1px
    classDef utility fill:#bfb,stroke:#333,stroke-width:1px
    classDef database fill:#ffc,stroke:#333,stroke-width:1px
    classDef external fill:#cdf,stroke:#333,stroke-width:1px
```
