# xsga/filmaffinity-api architecture

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

- Interactive diagram: https://gitdiagram.com/xsga/filmaffinity-api
- Repository: https://github.com/xsga/filmaffinity-api

## Overview

##### Main Components
- API/Web Server Layer:
– Public entry point: The “public/index.php” file that routes incoming HTTP requests.
– Slim framework routing defined in “config/routes/Routes.php”.
– .htaccess configuration (in “public/”) for rewriting URLs.
- Dependency Injection (DI) & Configuration:
– DI container configuration in “config/container/Container.php”.
– Environment configuration files in “config/env/Settings.php” and “config/.env”.
– Global error and logging settings found in “config/errors/” and “config/logger/”.
- Application Modules (Organized in DDD style under “src/Xsga/FilmAffinityApi/Modules”):
– Films Module – Contains application services, domain models, repositories, controllers, mappers, parsers, and console commands.
– Errors Module – Handles API error responses and related domain exceptions.
– Users Module – Manages user authentication, user creation, token generation, and security aspects.
– Shared Module – Provides common functionalities such as JWT handling, HTTP Client wrappers, JSON utilities, persistence and security utilities.
- Logging Subsystem:
– Custom logging provided under “src/Log4Php” that includes appenders, filters, layouts, and configuration adapters.
- Database & Persistence:
– The project uses MySQL (database scripts located in “scripts/”) along with Doctrine entities (e.g., “src/Xsga/FilmAffinityApi/Modules/Shared/Persistence/Infrastructure/Doctrine/UsersEntity.php”).
- CLI (Console Commands):
– Executable via “bin/console” (and related console classes under the modules) for tasks such as user creation/deletion, token generation, and backup operations.
- Containerization and DevOps:
– Docker support via “Dockerfile” and the “docker-compose.yml” file.
– Continuous integration configurations in “.circleci/” and “.github/workflows/”.

##### Component Relationships and Interactions
- External clients (or users) send HTTP requests to the RESTful API endpoints.
- The web server (via public/index.php) channels these requests to the Slim framework’s routing defined in “config/routes/Routes.php”.
- Controllers (under each module’s Infrastructure/Controllers) receive requests and then delegate tasks to application services.
- The services perform business logic by invoking domain models and coordinating with repositories (data access operations and third-party integrations).
- The DI container (configured in “config/container/Container.php”) wires all dependencies together.
- The API returns responses through the controllers, with error handling, logging (using Log4Php) and JSON serialization.
- Additionally, backend processes (via CLI commands) enable administrative tasks such as user management and data backup.
- Docker and CI/CD components encapsulate and manage environments.

##### Architectural Patterns and Design Principles
- Layered Architecture / Domain-Driven Design (DDD): Separation among Application, Domain, and Infrastructure layers.
- Dependency Injection: Using the container for loose coupling.
- Modularity: Each core feature (Films, Errors, Users, Shared) is encapsulated in its own module.
- Logging Abstraction: A dedicated Log4Php sub-system allows flexible logging strategies.
- RESTful API design: Clear endpoints, HTTP methods, and JSON schema-based input validation (with schemas defined under “config/schemas”).
- Containerization: Docker integration ensuring a consistent deployment environment.

##### Relevant Technologies, Frameworks, and Libraries
- PHP 8.3+ and Slim Framework 4.
- Composer for dependency management.
- Doctrine ORM for database interactions.
- Log4Php for logging.
- Guzzle (or similar) HTTP Client support in the Shared module.
- JWT (FirebaseJwtService for secure token handling).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    ExtClient["External Client"]:::external

    %% API/Web Server Layer
    subgraph "API/Web Server Layer"
        API_Index["public/index.php"]:::api
        API_HTAccess["public/.htaccess"]:::api
        API_Routes["config/routes/Routes.php"]:::api
    end

    %% Dependency Injection & Configuration
    subgraph "Dependency Injection & Configuration"
        DI_Container["DI Container"]:::di
        Env_Settings["Env Settings"]:::di
        Env_Example["Env .env.example"]:::di
        Error_Settings["Error Settings"]:::di
        Logger_Config["Logger Config"]:::di
    end

    %% Application Modules (Domain-Driven Design)
    subgraph "Application Modules"
        Films_Module["Films Module"]:::module
        Errors_Module["Errors Module"]:::module
        Users_Module["Users Module"]:::module
        Shared_Module["Shared Module"]:::module
    end

    %% Logging Subsystem
    subgraph "Logging Subsystem"
        Log4Php["Log4Php"]:::log
    end

    %% Database & Persistence
    subgraph "Database & Persistence"
        DBScripts["DB Scripts"]:::db
        Doctrine_Entity["UsersEntity (Doctrine)"]:::db
    end

    %% CLI (Console Commands)
    subgraph "CLI (Console Commands)"
        CLI_Executable["bin/console"]:::cli
        Films_CLI["Films CLI"]:::cli
        Users_CLI["Users CLI"]:::cli
    end

    %% Containerization & DevOps
    subgraph "Containerization and DevOps"
        Docker_Support["Docker Support"]:::dev
        Dev_Container["Dev Container"]:::dev
        CircleCI["CircleCI"]:::dev
        GitHub_WF["GitHub Workflows"]:::dev
    end

    %% Relationships
    ExtClient -->|requests| API_HTAccess
    API_HTAccess -->|rewrites| API_Index
    API_Index -->|routes| API_Routes

    DI_Container --> API_Index
    DI_Container --> API_Routes
    DI_Container --> Films_Module
    DI_Container --> Errors_Module
    DI_Container --> Users_Module
    DI_Container --> Shared_Module

    API_Routes --> Films_Module
    API_Routes --> Errors_Module
    API_Routes --> Users_Module
    API_Routes --> Shared_Module

    Films_Module -->|logs| Log4Php
    Errors_Module -->|logs| Log4Php
    Users_Module -->|logs| Log4Php

    Films_Module -->|persists| DBScripts
    Films_Module -->|persists| Doctrine_Entity
    Users_Module -->|persists| Doctrine_Entity
    Shared_Module -->|persists| Doctrine_Entity

    CLI_Executable --> Films_CLI
    CLI_Executable --> Users_CLI
    Films_CLI --> Films_Module
    Users_CLI --> Users_Module

    Docker_Support --> API_Index
    Docker_Support --> CLI_Executable
    CircleCI --> Docker_Support
    GitHub_WF --> Docker_Support
    Dev_Container --> Docker_Support

    %% Styles
    classDef external fill:#fffde7,stroke:#f9a825,stroke-width:2px;
    classDef api fill:#fde2e4,stroke:#e5989b,stroke-width:2px;
    classDef di fill:#e0f7fa,stroke:#00acc1,stroke-width:2px;
    classDef module fill:#f1f8e9,stroke:#7cb342,stroke-width:2px;
    classDef log fill:#fff3e0,stroke:#f57c00,stroke-width:2px;
    classDef db fill:#e8f5e9,stroke:#43a047,stroke-width:2px;
    classDef cli fill:#e3f2fd,stroke:#1e88e5,stroke-width:2px;
    classDef dev fill:#ede7f6,stroke:#5e35b1,stroke-width:2px;

    %% Click Events for API/Web Server Layer
    click API_Index "https://github.com/xsga/filmaffinity-api/blob/master/public/index.php"
    click API_HTAccess "https://github.com/xsga/filmaffinity-api/blob/master/public/.htaccess"
    click API_Routes "https://github.com/xsga/filmaffinity-api/blob/master/config/routes/Routes.php"

    %% Click Events for Dependency Injection & Configuration
    click DI_Container "https://github.com/xsga/filmaffinity-api/blob/master/config/container/Container.php"
    click Env_Settings "https://github.com/xsga/filmaffinity-api/blob/master/config/env/Settings.php"
    click Env_Example "https://github.com/xsga/filmaffinity-api/blob/master/config/.env.example"
    click Error_Settings "https://github.com/xsga/filmaffinity-api/tree/master/config/errors/"
    click Logger_Config "https://github.com/xsga/filmaffinity-api/blob/master/config/logger/log4php.xml"

    %% Click Events for Application Modules
    click Films_Module "https://github.com/xsga/filmaffinity-api/tree/master/src/Xsga/FilmAffinityApi/Modules/Films"
    click Errors_Module "https://github.com/xsga/filmaffinity-api/tree/master/src/Xsga/FilmAffinityApi/Modules/Errors"
    click Users_Module "https://github.com/xsga/filmaffinity-api/tree/master/src/Xsga/FilmAffinityApi/Modules/Users"
    click Shared_Module "https://github.com/xsga/filmaffinity-api/tree/master/src/Xsga/FilmAffinityApi/Modules/Shared"

    %% Click Event for Logging Subsystem
    click Log4Php "https://github.com/xsga/filmaffinity-api/tree/master/src/Log4Php"

    %% Click Events for Database & Persistence
    click DBScripts "https://github.com/xsga/filmaffinity-api/tree/master/scripts/"
    click Doctrine_Entity "https://github.com/xsga/filmaffinity-api/blob/master/src/Xsga/FilmAffinityApi/Modules/Shared/Persistence/Infrastructure/Doctrine/UsersEntity.php"

    %% Click Events for CLI (Console Commands)
    click CLI_Executable "https://github.com/xsga/filmaffinity-api/tree/master/bin/console"
    click Films_CLI "https://github.com/xsga/filmaffinity-api/tree/master/src/Xsga/FilmAffinityApi/Modules/Films/Infrastructure/Console"
    click Users_CLI "https://github.com/xsga/filmaffinity-api/tree/master/src/Xsga/FilmAffinityApi/Modules/Users/Infrastructure/Console"

    %% Click Events for Containerization & DevOps
    click Docker_Support "https://github.com/xsga/filmaffinity-api/blob/master/docker-compose.yml"
    click Dev_Container "https://github.com/xsga/filmaffinity-api/blob/master/.devcontainer/devcontainer.json"
    click CircleCI "https://github.com/xsga/filmaffinity-api/blob/master/.circleci/config.yml"
    click GitHub_WF "https://github.com/xsga/filmaffinity-api/blob/master/.github/workflows/php.yml"
```
