# bloom-ux/queulat architecture

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

- Interactive diagram: https://gitdiagram.com/bloom-ux/queulat
- Repository: https://github.com/bloom-ux/queulat

## Overview

##### Main Components

a. Core System Components:
- Bootstrap System
- Post Type Management System
- Metabox System
- Form System
- Validation System
- Generator System

b. Key Architectural Layers:
- WordPress Integration Layer
- Form Management Layer
- Code Generation Layer
- Validation Layer

**┌─────────────────────────────────────────────────────┐**
- WordPress Core                      │
- ┘
- ↑
**┌─────────────────────────────────────────────────────┐**
- Queulat Framework                   │
- ┬──────────────┬────────────┬──────────┤
- Core       │    Forms     │ Generator  │ Validator │
- System     │    System    │ System     │ System    │
- ┴──────────────┴────────────┴──────────┘

##### Detailed Component Breakdown

a. Core System (src/core):
- Post Type, Post Query, and Post Object components
- Relationship with Metabox system

b. Forms System (src/forms):
- Form Components
- HTML Elements
- Form Views
- Node Factory

c. Generator System (src/generator):
- Relationship between:
- CPT Plugin Generator
- Custom Post Type Builder
- Stub Templates

d. Validator System (src/validator):
- Validation rules
- Connection to form components

##### Data Flow Indicators

- How data flows from WordPress to Queulat components
- Form submission and validation flow
- Code generation process flow

##### Important Relationships to Highlight

- How Node Factory creates form elements
- Metabox integration with WordPress admin
- Demonstrate validation flow in forms
- Code generation process flow

##### Implementation Details

- Singleton pattern usage (via trait-singleton.php)
- Interface implementations
- Factory pattern in form element creation
- WordPress hook integration points

**┌─────────────────── Forms System ──────────────────┐**
- ┌─────────────┐  ┌─────────────┐  ┌─────────────┐ │
- Elements  │  │  Component  │  │    View     │ │
- Interface   │←─│   Factory   │─→│  Renderer   │ │
- ┘  └─────────────┘  └─────────────┘ │
- ↑              ↑                ↑          │
- ┌─────────────┐  ┌─────────────┐  ┌─────────────┐ │
- Concrete   │  │    Node     │  │    Form     │ │
- Elements   │  │   Factory   │  │    Views    │ │
- ┘  └─────────────┘  └─────────────┘ │
- ┘

## Diagram (Mermaid)

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

    subgraph QF["Queulat Framework"]
        subgraph Core["Core System"]
            Bootstrap["Bootstrap"]:::core
            PostType["Post Type Management"]:::core
            Metabox["Metabox System"]:::core
            PostQuery["Post Query"]:::core
            PostObject["Post Object"]:::core
        end

        subgraph Forms["Forms System"]
            FormComp["Form Components"]:::forms
            HTMLElem["HTML Elements"]:::forms
            FormViews["Form Views"]:::forms
            NodeFactory["Node Factory"]:::forms
            FormElements["Form Elements"]:::forms
            MetaboxForm["Metabox Form"]:::forms
            
            subgraph FormViewTypes["Form View Types"]
                WPSide["WordPress Side View"]:::forms
                WPWide["WordPress Wide View"]:::forms
            end
        end

        subgraph Generator["Generator System"]
            CPTPlugin["CPT Plugin Generator"]:::generator
            CPTBuilder["Custom Post Type Builder"]:::generator
            StubTemp["Stub Templates"]:::generator
            GenRenderer["Generator Renderer"]:::generator
        end

        subgraph Validator["Validator System"]
            MainValidator["Main Validator"]:::validator
            ValidatorInt["Validator Interface"]:::validator
            ValidationRules["Validation Rules"]:::validator
        end

        subgraph Helpers["Helper Components"]
            AdminHelp["Admin Helpers"]:::helper
            ArrayUtil["Array Utilities"]:::helper
            StringUtil["String Utilities"]:::helper
            AssetMgmt["Asset Management"]:::helper
        end
    end

    %% Relationships
    WPCore --> Bootstrap
    Bootstrap --> PostType
    Bootstrap --> Metabox
    Metabox --> MetaboxForm
    FormComp --> HTMLElem
    NodeFactory --> FormElements
    FormViews --> WPSide
    FormViews --> WPWide
    CPTPlugin --> CPTBuilder
    CPTBuilder --> StubTemp
    MainValidator --> ValidationRules
    ValidatorInt --> MainValidator

    %% Click Events
    click Bootstrap "https://github.com/bloom-ux/queulat/blob/main/src/core/class-bootstrap.php"
    click PostType "https://github.com/bloom-ux/queulat/blob/main/src/core/class-post-type.php"
    click Metabox "https://github.com/bloom-ux/queulat/blob/main/src/core/class-metabox.php"
    click PostQuery "https://github.com/bloom-ux/queulat/blob/main/src/core/class-post-query.php"
    click PostObject "https://github.com/bloom-ux/queulat/blob/main/src/core/class-post-object.php"
    click FormComp "https://github.com/bloom-ux/queulat/blob/main/src/forms/class-form-component.php"
    click HTMLElem "https://github.com/bloom-ux/queulat/blob/main/src/forms/class-html-element.php"
    click FormViews "https://github.com/bloom-ux/queulat/blob/main/src/forms/class-form-view.php"
    click NodeFactory "https://github.com/bloom-ux/queulat/blob/main/src/forms/class-node-factory.php"
    click FormElements "https://github.com/bloom-ux/queulat/tree/main/src/forms/elements/"
    click MetaboxForm "https://github.com/bloom-ux/queulat/blob/main/src/forms/class-metabox-form.php"
    click CPTPlugin "https://github.com/bloom-ux/queulat/blob/main/src/generator/admin/class-cpt-plugin.php"
    click CPTBuilder "https://github.com/bloom-ux/queulat/blob/main/src/generator/builder/class-custom-post-type.php"
    click StubTemp "https://github.com/bloom-ux/queulat/tree/main/src/generator/stubs/"
    click GenRenderer "https://github.com/bloom-ux/queulat/blob/main/src/generator/class-renderer.php"
    click MainValidator "https://github.com/bloom-ux/queulat/blob/main/src/validator/class-validator.php"
    click ValidatorInt "https://github.com/bloom-ux/queulat/blob/main/src/validator/interface-validator.php"
    click ValidationRules "https://github.com/bloom-ux/queulat/tree/main/src/validator/rules/"
    click AdminHelp "https://github.com/bloom-ux/queulat/blob/main/src/helpers/class-abstract-admin.php"
    click ArrayUtil "https://github.com/bloom-ux/queulat/blob/main/src/helpers/class-arrays.php"
    click StringUtil "https://github.com/bloom-ux/queulat/blob/main/src/helpers/class-strings.php"
    click AssetMgmt "https://github.com/bloom-ux/queulat/blob/main/src/helpers/class-webpack-asset-loader.php"
    click WPSide "https://github.com/bloom-ux/queulat/blob/main/src/forms/view/class-wp-side.php"
    click WPWide "https://github.com/bloom-ux/queulat/blob/main/src/forms/view/class-wp-wide.php"

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef forms fill:#4CAF50,stroke:#2E7D32,color:white
    classDef generator fill:#FF9800,stroke:#EF6C00,color:white
    classDef validator fill:#F44336,stroke:#C62828,color:white
    classDef helper fill:#9E9E9E,stroke:#616161,color:white
```
