# cabot/damaioconfiguration architecture

> Architecture diagram of the GitHub repository cabot/damaioconfiguration, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cabot/damaioconfiguration
- Repository: https://github.com/cabot/damaioconfiguration

## Overview

##### Project type and purpose
- This is a phpBB “extension” (plugin) named “damaioconfiguration.”
- Purpose: expose a GUI in the phpBB Admin Control Panel (ACP) that lets administrators configure the damaïo style without editing its files directly.
- It integrates tightly with phpBB’s event system, template overrides, language packs, and migration scripts.

##### File structure
- Top-level files:
- README.md, license.txt, composer.json, versioncheck.json
- config/services.yml → Symfony-style service definitions for phpBB
- Directories:
- acp/ → controller module classes for the ACP menu entries
- adm/style/ → CSS, HTML, JS assets used in the ACP interface
- event/ → event listener(s) that hook into phpBB life cycle
- helper/ → utility classes (e.g., logo_path_helper)
- language/ → per-locale language files for UI text
- migrations/ → database or configuration version-upgrade scripts
- styles/damaio/template/ → template snippets injected into the front-end style

##### README for additional insights
- Confirms this is a phpBB ≥3.3.15 extension for the damaïo style package.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Core and external
    subgraph "phpBB Core" 
        direction TB
        Core["phpBB Core"]:::core
    end

    subgraph "damaioconfiguration Extension" 
        direction TB
        %% ACP Module
        subgraph "ACP Module"
            direction TB
            ACP_Info["damaio_info.php"]:::extension
            ACP_Module["damaio_module.php"]:::extension
        end

        %% Configuration Service
        subgraph "Configuration Service"
            direction TB
            ServicesYML["services.yml"]:::extension
            LogoHelper["logo_path_helper.php"]:::extension
        end

        %% Event Listener
        Listener["listener.php"]:::extension

        %% Front-end Template Overrides
        subgraph "Template Overrides"
            direction TB
            HeaderTpl["overall_header_stylesheets_after.html"]:::extension
            FooterTpl["overall_footer_body_after.html"]:::extension
            ConfigTpl["damaio_config.html"]:::extension
        end

        %% Migrations
        subgraph "Migrations"
            direction TB
            InstallMig["damaio_install.php"]:::extension
            UpdateIconsMig["v102_m1_update_icons.php"]:::extension
        end

        %% Language Packs
        subgraph "Language Packs"
            direction TB
            EnAcp["en/acp_damaio.php"]:::extension
            EnInfo["en/info_acp_damaio.php"]:::extension
            EnMain["en/main_damaio.php"]:::extension
            FrAcp["fr/acp_damaio.php"]:::extension
            FrInfo["fr/info_acp_damaio.php"]:::extension
            FrMain["fr/main_damaio.php"]:::extension
        end

        %% Static Assets
        subgraph "Static ACP Assets"
            direction TB
            CSS["acp_damaio.css"]:::extension
            HTML["acp_damaio.html"]:::extension
            JS["acp_damaio.js"]:::extension
        end
    end

    subgraph "External Dependency"
        direction TB
        DamaioStyle["damaïo Style"]:::external
    end

    DB[(phpBB Config Table)]:::db

    %% Relationships
    Core -->|"registers module on load"| ACP_Info
    Core -->|"registers module on load"| ACP_Module
    ACP_Info -->|"invokes on_acp_page_load"| ServicesYML
    ACP_Module -->|"invokes on_acp_page_load"| ServicesYML
    ServicesYML -->|"injects config service"| LogoHelper
    LogoHelper -->|"uses config API"| DB
    ACP_Module -->|"config->get/set"| DB
    Listener -->|"subscribes to template events"| Core
    Listener -->|"injects CSS/JS/templates"| HeaderTpl
    Listener -->|"injects CSS/JS/templates"| FooterTpl
    Listener -->|"injects configuration UI"| ConfigTpl
    InstallMig -->|"runs on enable"| DB
    UpdateIconsMig -->|"runs on upgrade"| DB
    Core -->|"loads language"| EnAcp
    Core -->|"loads language"| EnInfo
    Core -->|"loads language"| EnMain
    Core -->|"loads language"| FrAcp
    Core -->|"loads language"| FrInfo
    Core -->|"loads language"| FrMain
    Core -->|"serves ACP assets"| CSS
    Core -->|"serves ACP assets"| HTML
    Core -->|"serves ACP assets"| JS
    DamaioStyle -.->|"template overrides applied"| HeaderTpl

    %% Click Events
    click ACP_Info "https://github.com/cabot/damaioconfiguration/blob/main/acp/damaio_info.php"
    click ACP_Module "https://github.com/cabot/damaioconfiguration/blob/main/acp/damaio_module.php"
    click HeaderTpl "https://github.com/cabot/damaioconfiguration/blob/main/styles/damaio/template/event/overall_header_stylesheets_after.html"
    click FooterTpl "https://github.com/cabot/damaioconfiguration/blob/main/styles/damaio/template/event/overall_footer_body_after.html"
    click ConfigTpl "https://github.com/cabot/damaioconfiguration/blob/main/styles/damaio/template/event/damaio_config.html"
    click Listener "https://github.com/cabot/damaioconfiguration/blob/main/event/listener.php"
    click ServicesYML "https://github.com/cabot/damaioconfiguration/blob/main/config/services.yml"
    click LogoHelper "https://github.com/cabot/damaioconfiguration/blob/main/helper/logo_path_helper.php"
    click InstallMig "https://github.com/cabot/damaioconfiguration/blob/main/migrations/damaio_install.php"
    click UpdateIconsMig "https://github.com/cabot/damaioconfiguration/blob/main/migrations/v102_m1_update_icons.php"
    click EnAcp "https://github.com/cabot/damaioconfiguration/blob/main/language/en/acp_damaio.php"
    click EnInfo "https://github.com/cabot/damaioconfiguration/blob/main/language/en/info_acp_damaio.php"
    click EnMain "https://github.com/cabot/damaioconfiguration/blob/main/language/en/main_damaio.php"
    click FrAcp "https://github.com/cabot/damaioconfiguration/blob/main/language/fr/acp_damaio.php"
    click FrInfo "https://github.com/cabot/damaioconfiguration/blob/main/language/fr/info_acp_damaio.php"
    click FrMain "https://github.com/cabot/damaioconfiguration/blob/main/language/fr/main_damaio.php"
    click CSS "https://github.com/cabot/damaioconfiguration/blob/main/adm/style/acp_damaio.css"
    click HTML "https://github.com/cabot/damaioconfiguration/blob/main/adm/style/acp_damaio.html"
    click JS "https://github.com/cabot/damaioconfiguration/blob/main/adm/style/acp_damaio.js"

    %% Styles
    classDef core fill:#dddddd,stroke:#333,stroke-width:1px;
    classDef extension fill:#bbdefb,stroke:#1e88e5,stroke-width:1px;
    classDef external fill:#c8e6c9,stroke:#2e7d32,stroke-width:1px;
    classDef db fill:#ffe0b2,stroke:#e65100,stroke-width:2px;
```
