 |
VOOZH | about |
|
VOOZH | about |
This document provides an overview of the trait system in hypervel/bus. Jobs in this system gain their dispatching, queuing, and batching capabilities through three core traits: Dispatchable, Queueable, and Batchable. These traits provide fluent APIs for job configuration and enable jobs to integrate seamlessly with the dispatcher, queue system, and batch processing components.
For detailed documentation of individual traits, see:
For information on dispatching jobs using these traits, see Dispatching Jobs.
The three traits in hypervel/bus are designed to be composable, allowing jobs to use any combination of them based on required functionality. Each trait focuses on a specific aspect of job behavior:
Figure 1: Trait Architecture and Integration Points
Sources: src/Dispatchable.php1-87 src/Queueable.php1-279 src/Batchable.php1-93
Jobs typically use multiple traits together to gain comprehensive functionality. The most common composition patterns are:
| Pattern | Traits Used | Use Case | Example |
|---|---|---|---|
| Synchronous Job | Dispatchable only | Jobs that execute immediately without queuing | Command handlers, simple operations |
| Queue Job | Dispatchable + Queueable | Asynchronous jobs sent to queue system | Email sending, data processing |
| Batch Job | Dispatchable + Queueable + Batchable | Jobs that participate in batch operations | Bulk imports, parallel processing |
| Chained Job | Dispatchable + Queueable | Sequential job execution | Multi-step workflows |
Table 1: Common Trait Composition Patterns
Sources: src/Dispatchable.php1-87 src/Queueable.php1-279 src/Batchable.php1-93
Each trait defines specific properties and methods that become part of the job class. Understanding this structure is essential for effective job configuration.
Figure 2: Complete Property and Method Structure Across Traits
Sources: src/Dispatchable.php16-86 src/Queueable.php20-278 src/Batchable.php15-92
The Dispatchable trait provides static methods that serve as entry points for job dispatch:
| Method | Return Type | Purpose |
|---|---|---|
dispatch() | PendingDispatch | Create new job instance and return pending dispatch object |
dispatchIf() | PendingDispatch|Fluent | Conditionally dispatch based on boolean or closure |
dispatchUnless() | PendingDispatch|Fluent | Dispatch unless condition is true |
dispatchSync() | mixed | Dispatch synchronously and return result |
dispatchAfterResponse() | mixed | Dispatch after HTTP response is sent |
withChain() | PendingChain | Create job with chained jobs |
Table 2: Dispatchable Trait Methods
Sources: src/Dispatchable.php16-86
The Queueable trait defines properties for queue configuration and methods for fluent configuration:
Properties:
$connection: Queue connection name$queue: Queue name$delay: Delay before job execution$afterCommit: Wait for database transaction commit$middleware: Middleware pipeline$chained: Serialized chained jobs$chainConnection: Connection for entire chain$chainQueue: Queue for entire chain$chainCatchCallbacks: Chain failure callbacksConfiguration Methods:
| Method | Parameters | Purpose |
|---|---|---|
onConnection() | BackedEnum|string|null | Set job connection |
onQueue() | BackedEnum|string|null | Set job queue |
allOnConnection() | BackedEnum|string|null | Set connection for job and chain |
allOnQueue() | BackedEnum|string|null | Set queue for job and chain |
delay() | array|DateInterval|DateTimeInterface|int|null | Set job delay |
withoutDelay() | None | Clear delay (set to 0) |
afterCommit() | None | Wait for database commit |
beforeCommit() | None | Dispatch immediately |
through() | array|object | Set middleware |
Table 3: Queueable Configuration Methods
Chain Management Methods:
| Method | Purpose |
|---|---|
chain() | Set jobs that run after this job succeeds |
prependToChain() | Add job to beginning of chain |
appendToChain() | Add job to end of chain |
dispatchNextJobInChain() | Dispatch next job in sequence |
invokeChainCatchCallbacks() | Trigger failure callbacks |
Table 4: Queueable Chain Management Methods
Sources: src/Queueable.php20-248
The Batchable trait provides batch awareness and state access:
Properties:
$batchId: ID of parent batch$fakeBatch: Fake batch for testingMethods:
| Method | Return Type | Purpose |
|---|---|---|
batch() | ?Batch | Get parent batch instance |
batching() | bool | Check if batch is active and not cancelled |
withBatchId() | static | Set batch ID |
withFakeBatch() | array | Configure fake batch for testing |
Table 5: Batchable Trait Methods
Sources: src/Batchable.php15-92
The following diagram illustrates how the three traits interact during a typical job lifecycle:
Figure 3: Trait Interaction During Job Lifecycle
Sources: src/Dispatchable.php19-22 src/Queueable.php70-121 src/Batchable.php28-51
All three traits integrate with Hyperf's dependency injection container to resolve dependencies:
Figure 4: Container Integration in Traits
The Dispatchable trait resolves the Dispatcher from the container at src/Dispatchable.php67-69:
The Batchable trait resolves the BatchRepository from the container at src/Batchable.php35-37:
This design enables:
Sources: src/Dispatchable.php65-69 src/Batchable.php34-38
The Queueable trait exemplifies the fluent API pattern used throughout hypervel/bus. All configuration methods return $this, enabling method chaining:
Figure 5: Fluent Method Chaining in Queueable Trait
Example method implementation at src/Queueable.php80-84:
This pattern allows expressive job configuration:
Sources: src/Queueable.php70-161
The Queueable trait implements sophisticated chain management through serialization and dynamic dispatch:
Figure 6: Chain Serialization and Execution Flow
The chain method at src/Queueable.php166-174 prepares nested batches and serializes jobs:
The dispatch method at src/Queueable.php224-237 handles chain continuation:
Sources: src/Queueable.php166-237
The traits include testing utilities to support unit and integration tests:
The Queueable trait provides assertions at src/Queueable.php253-278:
| Method | Purpose |
|---|---|
assertHasChain() | Verify job has expected chained jobs |
assertDoesntHaveChain() | Verify job has no chained jobs |
Table 6: Queueable Testing Assertions
The Batchable trait provides fake batch creation at src/Batchable.php66-92:
This enables testing batch-aware jobs without requiring actual batch infrastructure.
Sources: src/Queueable.php253-278 src/Batchable.php66-92
| Trait | Required When | Optional When |
|---|---|---|
Dispatchable | Job needs static dispatch methods | Using dispatch() helper function |
Queueable | Job implements ShouldQueue interface | Configuring delays, middleware, or chains |
Batchable | Job participates in batches | Job needs batch state access |
Table 7: Trait Usage Guidelines
A minimal queueable job with all traits:
This job can be:
ProcessOrder::dispatch($order)Sources: src/Dispatchable.php14-87 src/Queueable.php20-279 src/Batchable.php13-93
The traits integrate with multiple bus components to provide complete functionality:
Figure 7: Trait Integration with Bus Components
Sources: src/Dispatchable.php1-87 src/Queueable.php1-279 src/Batchable.php1-93
The trait system in hypervel/bus provides composable, focused functionality for jobs:
Dispatchable: Provides static entry points for job dispatchQueueable: Enables queue configuration, delays, middleware, and chainingBatchable: Provides batch awareness and state accessThese traits follow the fluent API pattern, integrate with Hyperf's dependency injection container, and compose together to provide comprehensive job functionality. Jobs typically use all three traits when implementing the ShouldQueue interface.
For detailed information on each trait, see the dedicated pages: Dispatchable, Queueable, and Batchable.
Sources: src/Dispatchable.php1-87 src/Queueable.php1-279 src/Batchable.php1-93
Refresh this wiki