# nilportugues/php-sql-query-builder architecture

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

- Interactive diagram: https://gitdiagram.com/nilportugues/php-sql-query-builder
- Repository: https://github.com/nilportugues/php-sql-query-builder

## Overview

##### High-Level Components

**┌─────────────────────────────────────────────────────┐**
- Client Application                  │
- ┘
- ↓
**┌─────────────────────────────────────────────────────┐**
- Query Builder Core                  │
- ┬─────────────────┬────────────-┤
- Builder        │   Manipulation   │   Syntax    │
- ┴─────────────────┴────────────-┘
- ↓
**┌─────────────────────────────────────────────────────┐**
- Database System                     │
- ┘

##### Core Components Breakdown

**Builder Component**
**┌────────────────────────────────┐**
- BuilderInterface               │
- ┤
- GenericBuilder              │
- MySqlBuilder                │
- BuilderException            │
- ┘

**Manipulation Component**
**┌────────────────────────────────┐**
- QueryInterface                 │
- ┤
- AbstractBaseQuery           │
- Select/Insert/Update/Delete │
- Union/Intersect/Minus       │
- QueryFactory                │
- ┘

**Syntax Component**
**┌────────────────────────────────┐**
- QueryPartInterface             │
- ┤
- Column/Table/Where          │
- OrderBy                     │
- SyntaxFactory               │
- ┘

##### Builder Syntax Writers

**┌─────────────────────────────┐**
- AbstractBaseWriter       │
- ┬───────────────┘
- ↓
**┌─────────────────────────────┐**
- AbstractSetWriter        │
- ┬───────────────┘
- ↓
**┌─────────────────────────────┐**
- Specific Writers            │
- ┤
- SelectWriter             │
- InsertWriter             │
- UpdateWriter             │
- DeleteWriter             │
- WhereWriter              │
- etc...                   │
- ┘

##### Data Flow Representation

**Client → Builder → QueryFactory → Query Objects → Writers → SQL String**
- ↓
- Values Array

##### Important Design Elements to Highlight

- Blue: Core interfaces
- Green: Concrete implementations
- Yellow: Factories
- Red: Exceptions

- Use different line styles:

##### Additional Notes

- Version information
- Supported database systems (Generic SQL-2003 and MySQL)
- Where query binding happens
- Separation between query building and execution

##### Implementation Details to Note

- The Builder pattern implementation
- Factory pattern usage
- Interface segregation
- Composition over inheritance
- Chain of responsibility in query building

Remember to include notes about:
- The stateless nature of the query builder
- The separation between query building and execution
- The value binding system
- The extensibility points for new database dialects

This will provide a complete picture of how the SQL Query Builder works while maintaining the right level of abstraction for a principal software engineer to understand the system's architecture.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Main Layers
    subgraph CL["Client Layer"]
        Client["Client Application"]:::client
    end

    subgraph Core["Query Builder Core"]
        subgraph BC["Builder Component"]
            BI["BuilderInterface"]:::interface
            GB["GenericBuilder"]:::implementation
            MB["MySqlBuilder"]:::implementation
            BE["BuilderException"]:::exception
        end

        subgraph MC["Manipulation Component"]
            QI["QueryInterface"]:::interface
            ABQ["AbstractBaseQuery"]:::abstract
            QF["QueryFactory"]:::factory
            
            subgraph Queries["Query Types"]
                Select["Select Query"]:::implementation
                Insert["Insert Query"]:::implementation
                Update["Update Query"]:::implementation
                Delete["Delete Query"]:::implementation
                Union["Union"]:::implementation
                Intersect["Intersect"]:::implementation
                Minus["Minus"]:::implementation
            end
        end

        subgraph SC["Syntax Component"]
            QPI["QueryPartInterface"]:::interface
            Column["Column"]:::implementation
            Table["Table"]:::implementation
            Where["Where"]:::implementation
            OrderBy["OrderBy"]:::implementation
            SF["SyntaxFactory"]:::factory
        end

        subgraph WC["Writer Component"]
            ABW["AbstractBaseWriter"]:::abstract
            ASW["AbstractSetWriter"]:::abstract
            
            subgraph Writers["Specific Writers"]
                SW["SelectWriter"]:::implementation
                IW["InsertWriter"]:::implementation
                UW["UpdateWriter"]:::implementation
                DW["DeleteWriter"]:::implementation
                WW["WhereWriter"]:::implementation
                WF["WriterFactory"]:::factory
            end
        end
    end

    subgraph DB["Database Layer"]
        Database["Database System"]:::database
    end

    %% Relationships
    Client --> BI
    BI --> GB & MB
    GB & MB --> QF
    QF --> Queries
    Queries --> SF
    SF --> Writers
    Writers --> Database

    %% Inheritance
    ABW --> ASW
    ASW --> Writers
    QI --> ABQ
    ABQ --> Queries

    %% Styling
    classDef interface fill:#a8d1ff,stroke:#333
    classDef implementation fill:#90EE90,stroke:#333
    classDef factory fill:#FFD700,stroke:#333
    classDef exception fill:#FFB6C1,stroke:#333
    classDef abstract fill:#E6E6FA,stroke:#333
    classDef database fill:#F0F8FF,stroke:#333
    classDef client fill:#F5F5F5,stroke:#333

    %% Click Events
    click BI "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/BuilderInterface.php"
    click GB "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/GenericBuilder.php"
    click MB "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/MySqlBuilder.php"
    click BE "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/BuilderException.php"
    click QI "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/QueryInterface.php"
    click ABQ "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/AbstractBaseQuery.php"
    click Select "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Select.php"
    click Insert "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Insert.php"
    click Update "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Update.php"
    click Delete "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Delete.php"
    click Union "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Union.php"
    click Intersect "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Intersect.php"
    click Minus "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/Minus.php"
    click QF "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Manipulation/QueryFactory.php"
    click QPI "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Syntax/QueryPartInterface.php"
    click Column "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Syntax/Column.php"
    click Table "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Syntax/Table.php"
    click Where "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Syntax/Where.php"
    click OrderBy "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Syntax/OrderBy.php"
    click SF "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Syntax/SyntaxFactory.php"
    click ABW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/AbstractBaseWriter.php"
    click ASW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/AbstractSetWriter.php"
    click SW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/SelectWriter.php"
    click IW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/InsertWriter.php"
    click UW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/UpdateWriter.php"
    click DW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/DeleteWriter.php"
    click WW "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/WhereWriter.php"
    click WF "https://github.com/nilportugues/php-sql-query-builder/blob/master/src/Builder/Syntax/WriterFactory.php"
```
