How mll-lab/php-utils works
Main Components
• Core Modules: Represent the overall library (“php-utils”) as the core container.
• Domain Utilities:
• Holidays Module (e.g., BavarianHolidays) – for managing and extending holiday data.
• CSV, Date, DNA, and String Utilities (classes like CSVArray, DateModification, DnaSequence, StringUtil) – general-purpose helper functions.
• Laboratory and Automation Specific Utilities:
• FluidXPlate Module – handling operations related to FluidX plate scanning and associated scalar classes.
• IlluminaSampleSheet Module – including separate submodules for V1 and V2 sample sheet formats.
• LightcyclerSampleSheet Module – for laboratory sample sheet processing.
• Microplate Module – including various coordinate systems, sectioning, and microplate set management.
• Tecan Module – consisting of several subdirectories for Basic and Custom Commands, Liquid Classes, Rack configurations, and Tecan Protocols.
• QxManager Module – handling sample sheet management related to Qx operations.
• PHPStan Integration:
• PHPStan extension and custom rules (inside PHPStan/ and the provided extension.neon and rules.neon) which integrate static analysis checks.
Relationships and Interactions
• All these modules reside under the “src” directory, implying they are loosely coupled but part of the same utility library.
• The integration with PHPStan should be shown as a supporting service that taps into specific utility functions or rules, indicated by a connection between the core library and the analysis tools.
Architectural Patterns
• Although it is a library rather than a full-stack application or microservice architecture, there is a clear modular design. Each submodule (e.g., IlluminaSampleSheet, Tecan, Microplate, etc.) is conceptually isolated.
• “separation of concerns”: each domain-specific utility is self-contained and reusable.
• The layered design (core utility functions, specialized domain libraries, and testing/integration layers) should be reflected.