# owen-it/laravel-auditing architecture

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

- Interactive diagram: https://gitdiagram.com/owen-it/laravel-auditing
- Repository: https://github.com/owen-it/laravel-auditing

## Overview

##### Main Components

a) Core Auditing System:
- AuditableObserver that watches for model changes
- Auditable trait that models can implement

b) Driver System:
- Database driver as the default storage mechanism
- An extension point for custom drivers
- To the database storage (audits table)

c) Resolver Components:
- Resolvers (IP, URL, UserAgent, User)
- How they feed information into the audit records

d) Event System:
- Event flow (Auditing → Audited → DispatchAudit)
- Event listeners and their connections

##### Relationship Flow

**Laravel Application**
- ↓
**Auditable Models → AuditableObserver**
- ↓
**Auditor (Core)**
- ↓
**Event Dispatcher**
- ↙     ↘
**Resolvers   Drivers**
- ↘     ↙
- Audit Storage

##### Implementation Details to Highlight

a) Contract Layer:
- Interfaces in src/Contracts as a separate layer

b) Support Systems:
- Attribute modifiers (encoders, redactors)
- Console commands as administrative tools

##### Specific Elements

- Audit lifecycle (pre-audit → audit → post-audit)
- Extension points for custom implementations
- Configuration flow from config/audit.php

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core["Core System"]
        Auditor["Auditor"]:::core
        AuditableObserver["AuditableObserver"]:::core
        AuditableTrait["Auditable Trait"]:::core
        AuditModel["Audit Model"]:::core
    end

    subgraph Drivers["Driver System"]
        DatabaseDriver["Database Driver"]:::driver
        DriverContract["Driver Contract"]:::contract
    end

    subgraph Resolvers["Resolver System"]
        IpResolver["IP Address Resolver"]:::resolver
        UrlResolver["URL Resolver"]:::resolver
        UserAgentResolver["UserAgent Resolver"]:::resolver
        UserResolver["User Resolver"]:::resolver
        ResolverContract["Resolver Contract"]:::contract
    end

    subgraph Events["Event System"]
        AuditingEvent["Auditing Event"]:::event
        AuditedEvent["Audited Event"]:::event
        DispatchAuditEvent["DispatchAudit Event"]:::event
        EventListener["Process Dispatch Listener"]:::event
    end

    subgraph Support["Support System"]
        Base64Encoder["Base64 Encoder"]:::support
        LeftRedactor["Left Redactor"]:::support
        RightRedactor["Right Redactor"]:::support
    end

    subgraph Console["Console Commands"]
        DriverCommand["Audit Driver Command"]:::console
        ResolverCommand["Audit Resolver Command"]:::console
        InstallCommand["Install Command"]:::console
    end

    subgraph Config["Configuration"]
        MainConfig["audit.php"]:::config
        Migration["Database Migration"]:::config
    end

    %% Relationships
    AuditableTrait --> AuditableObserver
    AuditableObserver --> Auditor
    Auditor --> AuditingEvent
    AuditingEvent --> AuditedEvent
    AuditedEvent --> DispatchAuditEvent
    DispatchAuditEvent --> EventListener
    EventListener --> DatabaseDriver
    DatabaseDriver --> AuditModel

    Auditor --> IpResolver
    Auditor --> UrlResolver
    Auditor --> UserAgentResolver
    Auditor --> UserResolver

    DatabaseDriver -.-> DriverContract
    IpResolver & UrlResolver & UserAgentResolver & UserResolver -.-> ResolverContract

    MainConfig --> Auditor
    Migration --> DatabaseDriver

    %% Click Events
    click Auditor "https://github.com/owen-it/laravel-auditing/blob/master/src/Auditor.php"
    click AuditableObserver "https://github.com/owen-it/laravel-auditing/blob/master/src/AuditableObserver.php"
    click AuditableTrait "https://github.com/owen-it/laravel-auditing/blob/master/src/Auditable.php"
    click AuditModel "https://github.com/owen-it/laravel-auditing/blob/master/src/Models/Audit.php"
    click DatabaseDriver "https://github.com/owen-it/laravel-auditing/blob/master/src/Drivers/Database.php"
    click DriverContract "https://github.com/owen-it/laravel-auditing/blob/master/src/Contracts/AuditDriver.php"
    click IpResolver "https://github.com/owen-it/laravel-auditing/blob/master/src/Resolvers/IpAddressResolver.php"
    click UrlResolver "https://github.com/owen-it/laravel-auditing/blob/master/src/Resolvers/UrlResolver.php"
    click UserAgentResolver "https://github.com/owen-it/laravel-auditing/blob/master/src/Resolvers/UserAgentResolver.php"
    click UserResolver "https://github.com/owen-it/laravel-auditing/blob/master/src/Resolvers/UserResolver.php"
    click ResolverContract "https://github.com/owen-it/laravel-auditing/blob/master/src/Contracts/Resolver.php"
    click AuditingEvent "https://github.com/owen-it/laravel-auditing/blob/master/src/Events/Auditing.php"
    click AuditedEvent "https://github.com/owen-it/laravel-auditing/blob/master/src/Events/Audited.php"
    click DispatchAuditEvent "https://github.com/owen-it/laravel-auditing/blob/master/src/Events/DispatchAudit.php"
    click EventListener "https://github.com/owen-it/laravel-auditing/blob/master/src/Listeners/ProcessDispatchAudit.php"
    click Base64Encoder "https://github.com/owen-it/laravel-auditing/blob/master/src/Encoders/Base64Encoder.php"
    click LeftRedactor "https://github.com/owen-it/laravel-auditing/blob/master/src/Redactors/LeftRedactor.php"
    click RightRedactor "https://github.com/owen-it/laravel-auditing/blob/master/src/Redactors/RightRedactor.php"
    click DriverCommand "https://github.com/owen-it/laravel-auditing/blob/master/src/Console/AuditDriverCommand.php"
    click ResolverCommand "https://github.com/owen-it/laravel-auditing/blob/master/src/Console/AuditResolverCommand.php"
    click InstallCommand "https://github.com/owen-it/laravel-auditing/blob/master/src/Console/InstallCommand.php"
    click MainConfig "https://github.com/owen-it/laravel-auditing/blob/master/config/audit.php"
    click Migration "https://github.com/owen-it/laravel-auditing/blob/master/database/migrations/audits.stub"

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef driver fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef resolver fill:#FFC107,stroke:#FFA000,color:black
    classDef event fill:#FF5722,stroke:#E64A19,color:white
    classDef support fill:#4CAF50,stroke:#388E3C,color:white
    classDef console fill:#795548,stroke:#5D4037,color:white
    classDef config fill:#607D8B,stroke:#455A64,color:white
    classDef contract fill:#9E9E9E,stroke:#616161,color:white
```
