# ralphjsmit/laravel-seo architecture

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

- Interactive diagram: https://gitdiagram.com/ralphjsmit/laravel-seo
- Repository: https://github.com/ralphjsmit/laravel-seo

## Overview

##### Project type and purpose
- This is an open-source Laravel “SEO” package (a library, not a standalone app).
- It plugs into any Laravel application to generate SEO tags (meta, OpenGraph, Twitter, JSON-LD schemas) automatically, based on stored or dynamic data.

##### File‐structure highlights
- src/
- LaravelSEOServiceProvider.php – registers services, config, migrations, facades
- Facades/SEOManager.php – static façade over the SEOManager service
- SEOManager.php, TagManager.php – core services for assembling SEOData into tags
- Models/SEO.php – Eloquent model for persisting SEO overrides
- Support/, Schema/, Tags/ – builders and tag/schema definitions (fluent builders, collections, renderable classes)
- config/seo.php – configuration defaults (site_name, suffixes, robots, etc.)
- resources/views – blade partials for rendering tags
- database/migrations – schema for the seo table
- helpers.php – global seo() helper
- tests/ – feature and unit tests exercising every component

##### Key README insights
- Service provider publishes migration & config, auto-creates SEO records for models using HasSEO trait.
- Usage flows: Blade calls seo() or seo()->for($model) → SEOManager builds SEOData (from config, model’s SEO record, getDynamicSEOData, transformers) → TagManager/SchemaCollection assemble TagCollection → rendered in view.

- Host Laravel Application
- LaravelSEOServiceProvider
- Config (config/seo.php) & Migration (seo table)
- Eloquent Model (SEO) & HasSEO trait on user’s Model
- Facade (SEOManager) → resolves SEOManager service
- SEOManager service → orchestrates data sources & tag assembly
- TagManager & SchemaCollection (builders)
- SEOData & TagCollection objects
- Blade view (resources/views/*) or helper (seo())
- Optional: User-registered closures (SEODataTransformer, tagTransformer)

##### Relationships & data flow
- On boot: ServiceProvider loads config, migrations, registers singleton SEOManager.
- When a new Model with HasSEO is created: Observer (within HasSEO) auto-inserts SEO record.
- At request time, in Blade: seo() helper calls SEOManager façade →
- Gathers default config → fetches Eloquent SEO record → invokes getDynamicSEOData() if present → applies SEODataTransformer closures → passes final SEOData to TagManager → builds TagCollection → TagTransformer closures → returns rendered HTML tags.
- TagCollection passed back to Blade and injected into <head>.

##### Architectural patterns & principles
- Laravel service‐provider pattern to register package.
- Facade pattern for static API.
- Singleton service in IOC container for SEOManager.
- Builder/fluent interfaces (TagManager, SchemaCollection, ArticleSchema).
- Observer pattern triggered by HasSEO trait to auto-create related records.
- Separation of concerns: config, data model, data transformation, rendering.

##### Technologies & frameworks
- Laravel (ServiceProvider, Eloquent, Blade, IOC)
- PHP (namespaces, composer)
- JSON-LD for structured data
- PHPUnit / Pest for testing

##### Essential elements
- Config/seo.php → ServiceProvider
- Migration → SEO Model
- HasSEO trait → Model ↔ SEO Model
- seo() helper & SEOManager façade → SEOManager service
- SEOData sources (config, Eloquent, dynamic, transformers)
- TagManager/SchemaCollection → TagCollection → Blade view

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Host Application"
        HostApp["Laravel Host App"]:::host
        Model["User Model"]:::host
    end

    subgraph "Configuration"
        Config["config/seo.php"]:::config
        Migration["create_seo_table migration"]:::config
    end

    subgraph "Data Layer"
        SEOModel["SEO Model"]:::data
        HasSEO["HasSEO Trait"]:::data
    end

    subgraph "Service Layer"
        ServiceProvider["LaravelSEOServiceProvider"]:::service
        Facade["Facade: SEOManager"]:::service
        SEOMgr["SEOManager Service"]:::service
    end

    subgraph "Builders"
        TagMgr["TagManager"]:::service
        SchemaColl["SchemaCollection"]:::service
        SchemaBuilders["Schema Builders"]:::service
    end

    subgraph "DTOs & Collections"
        SEOData["SEOData DTO"]:::data
        TagCollection["TagCollection"]:::data
    end

    subgraph "Presentation"
        Helper["seo() Helper"]:::view
        Blade["Blade View / Partial"]:::view
    end

    HostApp -->|"bootloads"| ServiceProvider
    ServiceProvider -->|"publishes config"| Config
    ServiceProvider -->|"publishes migration"| Migration
    ServiceProvider -->|"registers singleton"| SEOMgr
    ServiceProvider -->|"registers facade"| Facade

    Model -->|"uses"| HasSEO
    HasSEO -->|"auto-creates"| SEOModel
    Migration -->|"creates table"| SEOModel

    Helper -->|"calls"| Facade
    Facade -->|"resolves"| SEOMgr

    SEOMgr -->|"reads defaults"| Config
    SEOMgr -->|"fetches record"| SEOModel
    SEOMgr -->|"invokes dynamic data"| SEOData
    SEOMgr -->|"builds DTO"| SEOData
    SEOMgr -->|"passes to"| TagMgr
    SEOMgr -->|"passes to"| SchemaColl

    TagMgr -->|"builds"| TagCollection
    SchemaColl -->|"uses builders"| SchemaBuilders

    TagCollection -->|"returned to"| Blade
    Blade -->|"renders HTML tags"| HostApp

    classDef host fill:#d4f4dd,stroke:#2b7a0b
    classDef config fill:#d0e1f9,stroke:#034f84
    classDef service fill:#cfe2f3,stroke:#084298
    classDef data fill:#fce8b2,stroke:#7a4a01
    classDef view fill:#e2d5f7,stroke:#5e35b1

    click ServiceProvider "https://github.com/ralphjsmit/laravel-seo/blob/main/src/LaravelSEOServiceProvider.php"
    click Config "https://github.com/ralphjsmit/laravel-seo/blob/main/config/seo.php"
    click Migration "https://github.com/ralphjsmit/laravel-seo/blob/main/database/migrations/create_seo_table.php.stub"
    click SEOModel "https://github.com/ralphjsmit/laravel-seo/blob/main/src/Models/SEO.php"
    click HasSEO "https://github.com/ralphjsmit/laravel-seo/blob/main/src/Support/HasSEO.php"
    click Facade "https://github.com/ralphjsmit/laravel-seo/blob/main/src/Facades/SEOManager.php"
    click SEOMgr "https://github.com/ralphjsmit/laravel-seo/blob/main/src/SEOManager.php"
    click TagMgr "https://github.com/ralphjsmit/laravel-seo/blob/main/src/TagManager.php"
    click SchemaColl "https://github.com/ralphjsmit/laravel-seo/blob/main/src/SchemaCollection.php"
    click SchemaBuilders "https://github.com/ralphjsmit/laravel-seo/tree/main/src/Schema/"
    click SEOData "https://github.com/ralphjsmit/laravel-seo/blob/main/src/Support/SEOData.php"
    click TagCollection "https://github.com/ralphjsmit/laravel-seo/blob/main/src/TagCollection.php"
    click Helper "https://github.com/ralphjsmit/laravel-seo/blob/main/src/helpers.php"
    click Blade "https://github.com/ralphjsmit/laravel-seo/blob/main/resources/views/tags/tag.blade.php"
```
