PHP code example of dskripchenko / laravel-delayed-process

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

dskripchenko / laravel-delayed-process example snippets

'allowed_entities' => [
    \App\Services\ReportService::class,
    \App\Services\ExportService::class,
],

declare(strict_types=1);

namespace App\Services;

final class ReportService
{
    public function generate(int $userId, string $format): array
    {
        // Long-running operation (30+ seconds)
        $data = $this->buildReport($userId, $format);

        return ['url' => $data['url'], 'rows' => $data['count']];
    }
}

use Dskripchenko\DelayedProcess\Contracts\ProcessProgressInterface;

final class ImportService
{
    public function __construct(
        private readonly ProcessProgressInterface $progress,
    ) {}

    public function run(array $rows): array
    {
        foreach ($rows as $i => $row) {
            $this->import($row);
            $this->progress->setProgress(intdiv(($i + 1) * 100, count($rows)));
        }

        return ['imported' => count($rows)];
    }
}

use Dskripchenko\DelayedProcess\Contracts\ProcessFactoryInterface;

final class ReportController extends ApiController
{
    public function generate(
        Request $request,
        ProcessFactoryInterface $factory,
    ): JsonResponse {
        $process = $factory->make(
            ReportService::class,
            'generate',
            $request->integer('user_id'),
            $request->string('format'),
        );

        return response()->json([
            'success' => true,
            'payload' => [
                'delayed' => ['uuid' => $process->uuid, 'status' => $process->status->value],
            ],
        ]);
    }
}

use Dskripchenko\DelayedProcess\Models\DelayedProcess;
use Dskripchenko\DelayedProcess\Resources\DelayedProcessResource;

Route::get('/api/common/delayed-process/status', function (Request $request) {
    $process = DelayedProcess::query()
        ->where('uuid', $request->query('uuid'))
        ->firstOrFail();

    return DelayedProcessResource::make($process);
});

use Dskripchenko\DelayedProcess\Contracts\ProcessFactoryInterface;

$process = $factory->make(
    entity: \App\Services\ExportService::class,
    method: 'exportCsv',
    // Variadic parameters passed to the handler method:
    $userId,
    $filters,
);

// Stored as {"model": "App\\Models\\Article", "limit": 500}
$factory->make(ExportService::class, 'export', ...['model' => Article::class, 'limit' => 500]);

final class ExportService
{
    public function export(string $model, Exporter $exporter, int $limit = 1000, string $format = 'csv'): array
    {
        // $exporter comes from the container, $format keeps its default
    }
}

$process = $factory->makeWithCallback(
    entity: \App\Services\ExportService::class,
    method: 'exportCsv',
    callbackUrl: 'https://your-app.com/webhooks/process-done',
    $userId,
);

// config/delayed-process.php
'allowed_entities' => [
    \App\Services\LightService::class,                           // default queue
    \App\Services\HeavyService::class => [                       // custom queue
        'queue' => 'heavy',
        'connection' => 'redis',
        'timeout' => 600,
    ],
],

// config/delayed-process.php
'allowed_entities' => [
    \App\Services\ReportService::class,
    \App\Services\ExportService::class,
    // Only these classes can be used as handlers
],

bash
php artisan vendor:publish --tag=delayed-process-config

bash
php artisan migrate

bash
php artisan delayed:process
php artisan delayed:process --max-iterations=100
php artisan delayed:process --sleep=10

bash
php artisan delayed:clear
php artisan delayed:clear --days=7
php artisan delayed:clear --chunk=1000

bash
php artisan delayed:unstuck
php artisan delayed:unstuck --timeout=30
php artisan delayed:unstuck --dry-run

bash
php artisan delayed:expire
php artisan delayed:expire --dry-run

bash
php artisan delayed:migrate-v1
php artisan delayed:migrate-v1 --force