# threepoles-sa/laravel-myfatoorah architecture

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

- Interactive diagram: https://gitdiagram.com/threepoles-sa/laravel-myfatoorah
- Repository: https://github.com/threepoles-sa/laravel-myfatoorah

## Overview

##### Project type and purpose
- This is a Laravel package (open-source tool) named “laravel-myfatoorah” that wraps the MyFatoorah payment API to simplify invoice creation, payment status checks, refunds, and token/mode configuration.
- It is not a standalone application—it plugs into any Laravel app via Composer and auto-discovery.

##### File structure
- Top-level:
- composer.json (package metadata, dependencies, auto-discovery)
- README.md / LICENSE.md
- src/
- MyFatoorahServiceProvider.php (registers services & publishes config)
- Facades/MyFatoorah.php (Laravel Facade for static access)
- MyFatoorah.php (main entry point, resolves to underlying service)
- Services/Service.php (base HTTP client logic)
- src/config/myfatoorah.php (configuration template for mode, token)

##### Additional README insights
- Usage pattern:
- Laravel auto-discovery loads the ServiceProvider.
- Config is published to the host app’s config/myfatoorah.php.
- Users call the Facade in Controllers to create invoices, handle callbacks, errors, refunds.
- No database or internal persistence—stateless HTTP calls to external API.

a. Main components
- Laravel Host Application
- Package ServiceProvider (bootstraps config & binds services)
- Laravel Facade (MyFatoorah)
- Core MyFatoorah Service class & HTTP client
- External MyFatoorah REST API
- Host App Controllers (calling the Facade)
- Host App Config (.env + published config file)
b. Relationships & interactions
1. At startup: Laravel auto-discovers ServiceProvider → merges/publishes config.
2. Controller invokes Facade::createInvoice() → Facade resolves to MyFatoorah service.
3. MyFatoorah service constructs HTTP request using credentials from config → sends to External MyFatoorah API.
4. Gets API response → returns to Controller → user redirect or JSON response.
5. Callback endpoint: Controller uses Facade::payment($id) → queries API.
6. Refund: Facade::refundInvoice($data) → HTTP call to API.
c. Architectural patterns & principles
- Service Provider / IoC Container binding
- Facade pattern for simple static interface
- Separation of concerns: Controllers handle HTTP, Facade/service handles API logic
- Configuration-driven behavior (modes, tokens)
- Stateless HTTP integration (no DB)
d. Key technologies & libraries
- PHP (>=7.x), Composer
- Laravel (6.x–9.x) Service Container & Facades
- Guzzle or HTTP client (in Service.php)
- MyFatoorah REST API

##### Elements
- Clear labels:
- “User Browser” → “Laravel Routes” → “Controller”
- “MyFatoorah Facade” → “MyFatoorah Service” → “MyFatoorah REST API”
- “Config/myfatoorah.php” & “.env”
- Request flow from user to external API and back
- Binding flow at app startup (ServiceProvider → IoC)
- Package components (Facade, ServiceProvider, Service class, config) in another
- External system (MyFatoorah API) in a distinct style

##### Detail
- Config ingestion from .env → published config → service provider.
- API interactions (create invoice, payment query, refund).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Host Application Layer
    subgraph "Host Application"
        User["User Browser"]:::hostApp
        Routes["Laravel Routes"]:::hostApp
        Controller["Host App Controller"]:::hostApp
        Env[".env"]:::hostApp
    end

    %% Package Layer
    subgraph "Laravel-MyFatoorah Package"
        Composer["composer.json"]:::package
        Readme["README.md"]:::package
        License["LICENSE.md"]:::package
        ServiceProvider["MyFatoorahServiceProvider"]:::package
        Config["config/myfatoorah.php"]:::package
        Facade["MyFatoorah Facade"]:::package
        CoreService["MyFatoorah Service"]:::package
        HttpClient["HTTP Client (Service.php)"]:::package
    end

    %% External Layer
    subgraph "External MyFatoorah API"
        ExternalAPI["MyFatoorah REST API"]:::external
    end

    %% Startup & Config Flow
    Composer -->|"Auto-discovered"| ServiceProvider
    Env -->|"Environment settings"| ServiceProvider
    ServiceProvider -->|"Publishes config"| Config
    ServiceProvider -->|"Registers Facade alias & binds Service"| Facade

    %% Request-Response Flow
    User -->|"HTTP request"| Routes
    Routes --> Controller
    Controller -->|"calls Facade (createInvoice/payment/refund)"| Facade
    Facade -->|"resolves via IoC"| CoreService
    CoreService -->|"builds request"| HttpClient
    HttpClient -->|"sends HTTP"| ExternalAPI
    ExternalAPI -->|"API response"| HttpClient
    HttpClient -->|"returns data"| CoreService
    CoreService -->|"returns to Facade"| Facade
    Facade -->|"response to Controller"| Controller
    Controller -->|"response to User"| User

    %% Click Events
    click ServiceProvider "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/src/MyFatoorahServiceProvider.php"
    click Facade "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/src/Facades/MyFatoorah.php"
    click CoreService "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/src/MyFatoorah.php"
    click HttpClient "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/src/Services/Service.php"
    click Config "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/src/config/myfatoorah.php"
    click Composer "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/composer.json"
    click Readme "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/README.md"
    click License "https://github.com/threepoles-sa/laravel-myfatoorah/blob/master/LICENSE.md"

    %% Styles
    classDef hostApp fill:#a2d2ff,stroke:#333,stroke-width:1px
    classDef package fill:#d8f3dc,stroke:#333,stroke-width:1px
    classDef external fill:#ffcad4,stroke:#333,stroke-width:1px
```
