# bonny/wordpress-simple-history architecture

> Architecture diagram of the GitHub repository bonny/wordpress-simple-history, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bonny/wordpress-simple-history
- Repository: https://github.com/bonny/wordpress-simple-history

## Overview

##### Main Components

a. Core Plugin Architecture:
- Config System (class-config.php)
- Autoloader (class-autoloader.php)
- Main Plugin Class (class-simple-history.php)

b. Logging System:
- Logger Base Class (loggers/class-logger.php)
- Log Query Handler (class-log-query.php)
- Event Details System (event-details directory)
- Log Levels Handler (class-log-levels.php)

c. Services Layer:
- Database Setup
- REST API
- Admin Pages
- Scripts & Templates
- Dropins Loader
- WP CLI Commands

d. Frontend/UI Components:
- React Components (src/components/)
- Admin Bar Integration
- Dashboard Widget
- Settings Pages

##### Relationships and Data Flow

- WordPress Core ↔ Simple History Plugin
- Loggers → Database
- UI Components → REST API → Database
- Services → Core Components
- Dropins → Core Extension Points

##### Integration Points

Highlight:
- WordPress Action/Filter Hooks
- REST API Routes
- WP CLI Integration
- Database Tables

##### The plugin's modular architecture with clear separation between
- Core functionality
- Logging system
- UI components
- Service layer

##### The extensibility points
- Dropin system
- Logger system
- Event details framework

##### The modern stack using
- React for UI
- REST API for data access
- WordPress integration points

**[WordPress Core]**
- ↓
**[Simple History Core]**
- ↓
**[Services Layer] → [Database]**
- ↓
**[Logging System] → [Event Details]**
- ↓
**[UI Components] → [REST API]**

Notes about the PSR-3 logging standard implementation and the plugin's API for developers, as these are key architectural features mentioned in the README.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph WP["WordPress Core"]
        WPCore["WordPress Core System"]
    end

    subgraph Core["Core Plugin Architecture"]
        MainPlugin["Main Plugin Class"]:::core
        Config["Config System"]:::core
        Autoloader["Autoloader"]:::core
    end

    subgraph Services["Services Layer"]
        DB_Setup["Database Setup"]:::service
        REST_API["REST API"]:::service
        AdminPages["Admin Pages"]:::service
        Scripts["Scripts & Templates"]:::service
        Dropins_Loader["Dropins Loader"]:::service
        WP_CLI["WP CLI Commands"]:::service
    end

    subgraph Logging["Logging System"]
        LoggerBase["Logger Base Class"]:::logger
        LogQuery["Log Query Handler"]:::logger
        LogLevels["Log Levels Handler"]:::logger
        EventDetails["Event Details System"]:::logger
    end

    subgraph UI["User Interface Components"]
        React["React Components"]:::ui
        AdminBar["Admin Bar Integration"]:::ui
        DashWidget["Dashboard Widget"]:::ui
        Settings["Settings Pages"]:::ui
    end

    subgraph Database
        DB[(Database Tables)]:::database
    end

    subgraph Loggers["Logger Implementations"]
        LoggerImpl["Various Loggers"]:::logger
    end

    subgraph API["REST API Layer"]
        EventsController["Events Controller"]:::api
        SearchController["Search Options Controller"]:::api
    end

    %% Relationships
    WPCore --> MainPlugin
    MainPlugin --> Config
    MainPlugin --> Autoloader
    
    MainPlugin --> Services
    Services --> DB_Setup
    Services --> REST_API
    Services --> AdminPages
    Services --> Scripts
    Services --> Dropins_Loader
    Services --> WP_CLI
    
    MainPlugin --> Logging
    Logging --> LoggerBase
    Logging --> LogQuery
    Logging --> LogLevels
    Logging --> EventDetails
    
    LoggerBase --> LoggerImpl
    
    REST_API --> API
    API --> DB
    
    UI --> API
    LogQuery --> DB
    
    %% Click Events
    click Config "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-config.php"
    click Autoloader "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-autoloader.php"
    click MainPlugin "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-simple-history.php"
    click LoggerBase "https://github.com/bonny/WordPress-Simple-History/blob/main/loggers/class-logger.php"
    click LogQuery "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-log-query.php"
    click EventDetails "https://github.com/bonny/WordPress-Simple-History/tree/main/inc/event-details/"
    click LogLevels "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-log-levels.php"
    click DB_Setup "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/services/class-setup-database.php"
    click REST_API "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/services/class-rest-api.php"
    click AdminPages "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/services/class-admin-pages.php"
    click Scripts "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/services/class-scripts-and-templates.php"
    click Dropins_Loader "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/services/class-dropins-loader.php"
    click WP_CLI "https://github.com/bonny/WordPress-Simple-History/tree/main/inc/services/wp-cli-commands/"
    click React "https://github.com/bonny/WordPress-Simple-History/tree/main/src/components/"
    click AdminBar "https://github.com/bonny/WordPress-Simple-History/blob/main/src/components/AdminBarQuickView.jsx"
    click DashWidget "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/services/class-dashboard-widget.php"
    click Settings "https://github.com/bonny/WordPress-Simple-History/blob/main/templates/settings-general.php"
    click LoggerImpl "https://github.com/bonny/WordPress-Simple-History/tree/main/loggers/"
    click EventsController "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-wp-rest-events-controller.php"
    click SearchController "https://github.com/bonny/WordPress-Simple-History/blob/main/inc/class-wp-rest-searchoptions-controller.php"

    %% Styles
    classDef core fill:#2374ab
    classDef service fill:#48a9a6
    classDef logger fill:#4caf50
    classDef ui fill:#9c27b0
    classDef database fill:#ff9800
    classDef api fill:#f44336

    %% Legend
    subgraph Legend
        CoreLegend["Core Components"]:::core
        ServiceLegend["Services"]:::service
        LoggerLegend["Logging Components"]:::logger
        UILegend["UI Components"]:::ui
        DBLegend["Database"]:::database
        APILegend["API"]:::api
    end
```
