 |
VOOZH | about |
|
VOOZH | about |
This page documents the installation process for the hypervel/bus package and explains how it integrates with a Hyperf application. The page covers Composer installation, automatic service registration through the ConfigProvider, and the dependency injection setup that makes the bus system available throughout your application.
For information about how to use the dispatch functions after installation, see Dispatch Functions. For details on the internal architecture and design patterns, see Architecture and System Design.
The hypervel/bus package requires the following dependencies:
| Dependency | Version Constraint | Purpose |
|---|---|---|
| PHP | ^8.2 | Minimum PHP version |
| hyperf/context | ~3.1.0 | Coroutine context management |
| hyperf/contract | ~3.1.0 | Framework contracts |
| hyperf/collection | ~3.1.0 | Data collections |
| hyperf/conditionable | ~3.1.0 | Conditional logic support |
| hyperf/coroutine | ~3.1.0 | Coroutine utilities |
| hyperf/support | ~3.1.0 | Framework utilities |
| nesbot/carbon | ^2.72.6 | Date/time handling |
| laravel/serializable-closure | ^1.3 | Closure serialization |
| hypervel/support | ^0.3 | Hypervel utilities |
| hypervel/cache | ^0.3 | Caching layer for batch data |
The package also suggests installing hypervel/queue for advanced job chaining with closures.
Sources: composer.json23-35 composer.json53-55
Install the package via Composer:
Once installed, the package automatically registers itself with your Hyperf application through the Hyperf auto-discovery mechanism.
Sources: composer.json2
The hypervel/bus package uses Hyperf's package discovery system to automatically configure itself. This is defined in the composer.json file's extra.hyperf section:
When your Hyperf application boots, it automatically discovers and loads the Hypervel\Bus\ConfigProvider class, which registers all necessary services into the dependency injection container.
Sources: composer.json45-51
The following diagram shows how services are registered during application bootstrap:
Sources: composer.json45-51 src/ConfigProvider.php11-22
The ConfigProvider class is responsible for registering all bus-related services. It implements a simple __invoke() method that returns a configuration array:
This configuration establishes three key service bindings:
Hypervel\Bus\Contracts\Dispatcher to Hypervel\Bus\DispatcherFactoryHypervel\Bus\Contracts\BatchRepository to Hypervel\Bus\DatabaseBatchRepository via a closureHypervel\Bus\DatabaseBatchRepository to Hypervel\Bus\DatabaseBatchRepositoryFactorySources: src/ConfigProvider.php13-21
The following table details each service binding registered by the ConfigProvider:
| Interface/Class | Factory/Implementation | Resolution Type |
|---|---|---|
Hypervel\Bus\Contracts\Dispatcher | Hypervel\Bus\DispatcherFactory | Factory class |
Hypervel\Bus\Contracts\BatchRepository | Hypervel\Bus\DatabaseBatchRepository | Closure that resolves from container |
Hypervel\Bus\DatabaseBatchRepository | Hypervel\Bus\DatabaseBatchRepositoryFactory | Factory class |
The package uses the Factory pattern for complex service construction. Instead of directly instantiating services, the container delegates to factory classes:
DispatcherFactory: Constructs the Dispatcher instance with necessary dependenciesDatabaseBatchRepositoryFactory: Constructs the DatabaseBatchRepository with configuration and dependenciesThis pattern enables:
Sources: src/ConfigProvider.php16-19
The following diagram illustrates how services are resolved at runtime when user code requests the dispatcher:
Sources: src/ConfigProvider.php16-19
The package configures PSR-4 autoloading for its namespace and also autoloads the helper functions file:
This configuration ensures that:
Hypervel\Bus namespace are autoloaded from the src/ directorydispatch() and dispatch_sync() helper functions are automatically available (see Dispatch Functions)Sources: composer.json37-43
After installation, verify that the package is correctly configured:
Verify that the dispatcher can be resolved from the container:
Ensure the global helper functions are available:
Verify the batch repository is accessible:
Sources: composer.json41-43 src/ConfigProvider.php16-19
Unlike some packages, hypervel/bus requires no additional configuration files or environment variables for basic operation. The package works out-of-the-box with sensible defaults:
For advanced batch storage configuration, see Database Implementation. For queue-specific configuration, see Queue Integration.
Sources: src/ConfigProvider.php11-22
The following diagram shows how hypervel/bus integrates with other Hyperf and Hypervel packages:
Sources: composer.json23-35 composer.json53-55
After running composer require hypervel/bus, the package:
ConfigProvider is discovered and registers three key services into the DI containerdispatch() and dispatch_sync() global functions become availableHypervel\Bus namespaceNo additional configuration steps are required. The package is ready to use immediately. To begin dispatching jobs, see Dispatching Jobs.
Refresh this wiki