How debva/nix works
Project type and purpose
• This is an open-source PHP micro-framework (“NIX PHP Framework”) designed as a reusable library for building web applications.
• It provides a minimal HTTP kernel, routing, middleware support, a service container, database adapters, console commands, task scheduling, and extension points for external APIs.
File structure
• Top-level:
• composer.json / vendor (external dependencies via Composer)
• public/index.php (web-server entry point)
• routes/ (user-defined route handlers)
• src/ (framework core classes)
• extensions/ (adapters for external healthcare APIs)
• plugins/ (custom plugins, e.g., task scheduler)
• stubs/ (code-generation templates)
• Patterns:
• Service Container / Facade style (src/App binds & exposes services)
• Adapter pattern for Database (Base, MySQL, PostgreSQL) and for external services in extensions
• Layered: HTTP → Routing → Business logic → Data access
README for technical stack
• Core technologies: PHP 7+, Composer, PSR-style autoloading
• Features: request/response, routing, validation, database, transactions, datatable, console & tasks, environment management, custom extensions (e.g., SatuSehat)
Main components & relationships
a. Public Entry Point
• public/index.php receives all HTTP traffic → loads Composer autoloader → instantiates Debva\Nix\App → invokes the HTTP kernel
b. HTTP Kernel & Router
• Debva\Nix\App acts as service container & kernel
• src/Http dispatches to src/Route, applies middleware, resolves route callback (in routes/)
c. Middleware & Services
• src/Authentication, Authorization, Validator, Cryptography, Session, Storage, Environment
• Each service registered in the App container, injected/resolved at runtime
d. Business Logic / User Code
• routes/*.php define endpoints using closures or controllers
• services under src/ and plugins may be called here
e. Data Layer
• src/Database\Base + adapters for MySQL, PostgreSQL
• src/Datatable for tabular queries
• src/Transaction, src/Query
f. Console & Scheduler
• src/Console & plugins/task_scheduler.py for cron-style job scheduling
• src/Task for background jobs, src/Telegram for messaging integration
g. Extensions / External Integrations
• extensions/ folder: BPJS, InaCBGs, SatuSehat (FHIR-style adapter)
• Each extension defines Auth, Base client, DataType, Mapping layers
h. Stubs & Code Generation
• stubs/ for generating commands, services, routes, middleware
Architectural patterns & principles
• Layered architecture (Presentation / HTTP, Application / Routing & Middleware, Domain / Business logic, Persistence / Database)
• Service Container / Dependency Injection
• Adapter pattern (DB, external APIs)
• Single responsibility per class (e.g., Database/MySQL, Auth vs DataType in extensions)