Download the PHP package b7s/laravel-queue-flow without Composer

Laravel Queue Flow

A Laravel Queue wrapper system, simplifying queue management without creating separate Job classes.

Features

• 🚀 Simple API: No need to create separate Job classes
• 🔒 Type-safe: Full PHP 8.2+ type hints
• 🎯 Fluent Interface: Chain methods for easy configuration
• 🔐 Encryption Support: Built-in job encryption
• 🔄 Unique Jobs: Prevent duplicate job execution
• ⚡ Rate Limiting: Control job execution rate
• 🎨 Flexible: Support for delays, connections, and queues
• 🧪 Tests: Pest tests included

Requirements

• PHP 8.2 or higher
• Laravel 11.0 or higher

Installation

Install the package via Composer:

The service provider will be automatically registered.

Publish Configuration (Optional)

This package has some configurations, but it doesn't override the default Laravel settings, which you can modify in config/queue.php.

Usage

Basic Usage

Using global helper function qflow:

Auto-dispatch on Destruction

The queue will automatically dispatch when the object is destroyed if a callback was added:

Know more about the dispatch() return value here.

Using the Queue instance directly:

Delayed Jobs

Dependency Injection

Resolve the queue via Laravel's container and keep your classes clean:

You can pass an array of closures to add() to add multiple jobs:

Helper Function

Use the global qflow() helper to configure jobs inline.

Jobs dispatch automatically by default

You can change this behavior changing the config auto_dispatch_on_queue_flow_helper or by setting the .env variable QUEUE_FLOW_AUTO_DISPATCH_ON_HELPER to false:

Disable auto-dispatch when you need more control (set the second parameter - autoDispatch - to false):

Without Relations

Prevent Eloquent model relations from being serialized:

Unique Jobs

Ensure a job is only queued once:

Unique Until Processing

Job is unique only until it starts processing:

Encrypted Jobs

Encrypt the job payload:

Failure Handling

Execute a callback when a job fails:

The failure callback receives the exception that caused the job to fail, allowing you to:

• Log detailed error information
• Send notifications to administrators
• Update database records
• Trigger compensating actions

Rate Limiting

Apply rate limiting to jobs:

Configure rate limiters in config/queue-flow.php:

Custom Queue and Connection

Chaining Multiple Options

The methods follow the same pattern and the same naming convention as Laravel (see Laravel Documentation).

Configuration

The configuration file allows you to set defaults:

• auto_dispatch – controls whether the fluent Queue instance should dispatch automatically when destructed (default: false).
• auto_dispatch_on_queue_flow_helper – controls the default behavior for the qflow() helper when autoDispatch is not passed explicitly (default: true).
• dispatch_return_of_multiple_jobs_as_collection – controls whether the dispatch method should return a collection of PendingDispatch objects when multiple jobs are dispatched (default: true).

How It Works

QueueFlow Queue abstracts Laravel's queue system by:

1. Wrapping closures in specialized Job classes
2. Applying configurations through a fluent interface
3. Dispatching jobs using Laravel's native queue system
4. Managing state through service classes

Testing

Running Tests

The package includes a comprehensive test suite covering all features. For detailed documentation, see TESTING.md.

Test Coverage

To generate a test coverage report (requires Xdebug or PCOV):

Key Test Scenarios

1. Basic Queue Operations

   • Job dispatching
   • Queue configuration
   • Error handling

2. Helper Function

3. Database Integration

   • Transaction handling
   • CRUD operations
   • Rollback on failure
4. Edge Cases
   • Large payloads
   • Error conditions
   • Concurrency issues

License

This package is open-sourced software licensed under the MIT license.

Credits

• Built on top of Laravel's robust queue system