# tursodatabase/turso-client-php architecture

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

- Interactive diagram: https://gitdiagram.com/tursodatabase/turso-client-php
- Repository: https://github.com/tursodatabase/turso-client-php

## Overview

##### Main Components Identification

- PHP Extension Interface Layer
- Core LibSQL Implementation
- Connection Providers
- Utility Services
- External Systems Integration

**[PHP Application Layer]**
- ↓
**[PHP Extension Interface]**
- ↓
**[Core LibSQL Implementation]**
- ↓
**[Connection Providers]**
- ↓
**[Database Backends]**

##### Component Details

a) PHP Extension Interface (Top Layer):
- Main extension entry points (LibSQL class)
- Statement and transaction handlers
- Hooks system

b) Core Implementation (Middle Layer):
- Rust implementation components
- Generator and result handling systems
- Utility services (config, runtime, query params)

c) Connection Providers (Lower Layer):
- Local connections
- Remote connections
- Remote replica connections
- Memory connections

##### Specific Elements

**[LibSQL PHP Class]**
- ↓
**[Hooks System] ← [Statement Handler]**
- ↓            [Transaction Handler]
**[Core Implementation]**
- ↓
**[Connection Providers] → [Local]**
- → [Remote]
- → [Remote Replica]
- → [Memory]

##### Important Relationships

- Error handling paths with red lines

##### Technical Details to Highlight

- FFI boundary between PHP and Rust
- Where async operations occur
- Where configuration is applied
- Where connection pooling happens

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph PHP
        App[PHP Application]
        ExtInt["PHP Extension Interface"]:::php
    end

    subgraph Core
        HookSys["Hooks System"]:::core
        StmtHand["Statement Handler"]:::core
        TransHand["Transaction Handler"]:::core
        CoreImpl["Core Implementation"]:::core
        GenSys["Generator System"]:::core
        ResHand["Result Handler"]:::core
    end

    subgraph Hooks
        direction TB
        Changes["Changes Hook"]:::hook
        Execute["Execute Hook"]:::hook
        Query["Query Hook"]:::hook
        Version["Version Hook"]:::hook
        AutoCommit["Autocommit Hook"]:::hook
    end

    subgraph Utils
        direction TB
        Config["Configuration"]:::util
        Runtime["Runtime"]:::util
        QueryParams["Query Parameters"]:::util
        ResultSet["Result Set"]:::util
    end

    subgraph Providers
        direction TB
        ConnProv["Connection Providers"]:::provider
        Local["Local Connection"]:::provider
        Remote["Remote Connection"]:::provider
        RemoteRep["Remote Replica"]:::provider
        Memory["Memory Connection"]:::provider
    end

    subgraph External
        DB[(Database)]
    end

    %% Relationships
    App --> ExtInt
    ExtInt --> HookSys
    HookSys --> CoreImpl
    CoreImpl --> ConnProv
    
    StmtHand --> CoreImpl
    TransHand --> CoreImpl
    
    CoreImpl --> GenSys
    CoreImpl --> ResHand
    
    HookSys --> Changes
    HookSys --> Execute
    HookSys --> Query
    HookSys --> Version
    HookSys --> AutoCommit
    
    ConnProv --> Local
    ConnProv --> Remote
    ConnProv --> RemoteRep
    ConnProv --> Memory
    
    Local --> DB
    Remote --> DB
    RemoteRep --> DB
    Memory --> DB

    %% Click Events
    click ExtInt "https://github.com/tursodatabase/turso-client-php/blob/main/libsql_php_extension.stubs.php"
    click HookSys "https://github.com/tursodatabase/turso-client-php/blob/main/src/hooks/mod.rs"
    click StmtHand "https://github.com/tursodatabase/turso-client-php/blob/main/src/statement.rs"
    click TransHand "https://github.com/tursodatabase/turso-client-php/blob/main/src/transaction.rs"
    click CoreImpl "https://github.com/tursodatabase/turso-client-php/blob/main/src/lib.rs"
    click GenSys "https://github.com/tursodatabase/turso-client-php/blob/main/src/generator.rs"
    click ResHand "https://github.com/tursodatabase/turso-client-php/blob/main/src/result.rs"
    click ConnProv "https://github.com/tursodatabase/turso-client-php/blob/main/src/providers/mod.rs"
    click Local "https://github.com/tursodatabase/turso-client-php/blob/main/src/providers/local.rs"
    click Remote "https://github.com/tursodatabase/turso-client-php/blob/main/src/providers/remote.rs"
    click RemoteRep "https://github.com/tursodatabase/turso-client-php/blob/main/src/providers/remote_replica.rs"
    click Config "https://github.com/tursodatabase/turso-client-php/blob/main/src/utils/config_value.rs"
    click Runtime "https://github.com/tursodatabase/turso-client-php/blob/main/src/utils/runtime.rs"
    click QueryParams "https://github.com/tursodatabase/turso-client-php/blob/main/src/utils/query_params.rs"
    click ResultSet "https://github.com/tursodatabase/turso-client-php/blob/main/src/utils/result_set.rs"
    click Changes "https://github.com/tursodatabase/turso-client-php/blob/main/src/hooks/changes.rs"
    click Execute "https://github.com/tursodatabase/turso-client-php/blob/main/src/hooks/use_exec.rs"
    click Query "https://github.com/tursodatabase/turso-client-php/blob/main/src/hooks/use_query.rs"
    click Version "https://github.com/tursodatabase/turso-client-php/blob/main/src/hooks/version.rs"
    click AutoCommit "https://github.com/tursodatabase/turso-client-php/blob/main/src/hooks/is_autocommit.rs"

    %% Styles
    classDef php fill:#2980b9,stroke:#2980b9,color:white
    classDef core fill:#27ae60,stroke:#27ae60,color:white
    classDef hook fill:#8e44ad,stroke:#8e44ad,color:white
    classDef provider fill:#d35400,stroke:#d35400,color:white
    classDef util fill:#7f8c8d,stroke:#7f8c8d,color:white
    
    %% Legend
    subgraph Legend
        PHP_Component["PHP Interface"]:::php
        Core_Component["Core Implementation"]:::core
        Hook_Component["Hook Component"]:::hook
        Provider_Component["Connection Provider"]:::provider
        Util_Component["Utility Service"]:::util
    end
```
