 |
VOOZH | about |
|
VOOZH | about |
This document provides a high-level overview of the hypervel/support package architecture, explaining how its foundational components work together to provide a clean, extensible API surface. The architecture follows a layered design pattern with four core infrastructure patterns: Facades, Service Providers, Managers, and Data Objects.
For detailed information about specific patterns, see:
The package follows a clear separation of concerns across multiple layers, each with distinct responsibilities.
Layer Responsibilities
| Layer | Purpose | Key Components |
|---|---|---|
| Package Definition | Defines dependencies and autoloading configuration | composer.json1-50 src/helpers.php |
| Core Infrastructure | Provides foundational patterns for building services | DataObject, Manager, Facade, ServiceProvider |
| Facade API | Static API surface for application code | 20+ facade classes in src/Facades/ |
| Implementation | Concrete service implementations | Managers, contracts, and service classes |
| Backend Services | External systems and storage | Databases, cache servers, message queues |
Sources: composer.json1-50 src/Facades/Facade.php1-264 src/DataObject.php1-589 src/Manager.php1-157
The package is built on four foundational patterns that work together to provide extensibility, clean APIs, and type safety.
Sources: src/Facades/Facade.php1-264 src/Manager.php1-157 src/DataObject.php1-589 src/Reflector.php1-136
The Facade abstract class provides a static proxy to services in the dependency injection container. Each facade implements getFacadeAccessor() to specify which container binding it proxies.
Key Implementation Details:
$resolvedInstance array__callStatic forwards calls to the resolved instancespy() and swap() methods for test doublesExample Facade Resolution Flow:
Sources: src/Facades/Facade.php144-153 src/Facades/Facade.php169-192 src/Facades/Facade.php177-192
The Manager abstract class implements the driver pattern for multi-backend services. It provides lazy instantiation, driver caching, and extensibility through custom creators.
Architecture:
getDefaultDriver()driver(?string $driver) resolves and caches driverscreateDriver() uses convention-based method names (create{Driver}Driver)extend() registers custom driver creators__call() forwards to default driverDriver Resolution Logic:
| Step | Method | Description |
|---|---|---|
| 1 | Check cache | src/Manager.php56 - Return cached driver if exists |
| 2 | Check custom creator | src/Manager.php73-75 - Call registered closure if exists |
| 3 | Check factory method | src/Manager.php77-81 - Call create{StudlyDriver}Driver() |
| 4 | Throw exception | src/Manager.php83 - Driver not supported |
Sources: src/Manager.php1-157
The DataObject abstract class provides strongly-typed DTOs with automatic type casting, dependency resolution, and serialization. It uses reflection to map constructor parameters to data keys.
Core Features:
Type Conversion System:
The auto-casting system handles multiple scenarios:
| Type | Handler | Location |
|---|---|---|
| Primitive types | convertValueToType() | src/DataObject.php411-432 |
| Nested DataObjects | resolveDependenciesMap() | src/DataObject.php254-313 |
| DateTime types | getCustomizedDependencies() | src/DataObject.php109-118 |
| Enum types | Direct from() call | src/DataObject.php292-299 |
Property Mapping:
convertDataKeyToProperty()convertPropertyToDataKey()Serialization:
getSerializers() for special typesJsonSerializableSources: src/DataObject.php1-589
The following diagram shows how application code interacts with the architecture to perform a typical operation.
Sources: src/Facades/Facade.php144-153 src/DataObject.php62-93
The package is defined through Composer configuration and depends on Hyperf 3.1.x ecosystem packages.
Dependencies:
| Dependency | Version | Purpose |
|---|---|---|
hyperf/context | ~3.1.0 | Application context management |
hyperf/support | ~3.1.0 | Base support utilities |
hyperf/collection | ~3.1.0 | Collection data structure |
nesbot/carbon | ^2.72.6 | DateTime manipulation |
league/uri | ^7.5 | URI manipulation |
Autoloading Configuration:
Hypervel\Support\ namespace maps to src/src/Functions.php and src/helpers.phpSources: composer.json1-50
The package provides ~40 global helper functions that complement the facade layer for common operations. These are auto-loaded via Composer's files directive.
Helper Categories:
data_get(), data_set(), data_fill(), data_forget()collect(), value()retry(), tap(), once(), transform()e(), blank(), filled(), class_basename()env(), environment()These helpers provide procedural alternatives to facade calls for brevity in application code.
Sources: composer.json36-39
The Reflector class provides utilities for inspecting callables and parameter types, used extensively by the DataObject system.
Key Methods:
The Reflector is particularly important for the DataObject's dependency resolution system src/DataObject.php254-313
Sources: src/Reflector.php1-136
The architecture includes first-class testing support through the facade system. Facades can be swapped with test doubles without modifying application code.
Testing Methods:
| Method | Location | Purpose |
|---|---|---|
spy() | src/Facades/Facade.php42-53 | Create Mockery spy |
partialMock() | src/Facades/Facade.php58-67 | Partial mock with real methods |
shouldReceive() | src/Facades/Facade.php72-81 | Set Mockery expectations |
swap() | src/Facades/Facade.php131-136 | Replace with custom instance |
isFake() | src/Facades/Facade.php158-164 | Check if fake installed |
This enables isolated unit testing by intercepting facade calls at the container level. For details on specific testing patterns, see Testing Overview.
Sources: src/Facades/Facade.php42-136
The hypervel/support package architecture provides:
These patterns work together through the PSR-11 container to provide a cohesive foundation for building Hyperf applications with Laravel-like ergonomics.
Refresh this wiki