PHPackages neuron-php/jobs - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Queues & Workers](/categories/queues) 4. / 5. neuron-php/jobs ActiveLibrary[Queues & Workers](/categories/queues) neuron-php/jobs =============== Job scheduler and runner. 0.2.14(4w ago)01.6k—0%2MITPHPCI passing Since Jan 8Pushed 4w agoCompare [ Source](https://github.com/Neuron-PHP/jobs)[ Packagist](https://packagist.org/packages/neuron-php/jobs)[ RSS](/packages/neuron-php-jobs/feed)WikiDiscussions develop Synced today READMEChangelogDependencies (6)Versions (22)Used By (2) [![CI](https://github.com/Neuron-PHP/jobs/actions/workflows/ci.yml/badge.svg)](https://github.com/Neuron-PHP/jobs/actions)[![codecov](https://camo.githubusercontent.com/94a221c849801e67cb1f89cc59c5c8d0fce04cd34168dbb1f753480976edd967/68747470733a2f2f636f6465636f762e696f2f67682f4e6575726f6e2d5048502f6a6f62732f6272616e63682f646576656c6f702f67726170682f62616467652e737667)](https://codecov.io/gh/Neuron-PHP/jobs) Neuron-PHP Job Scheduler & Queue ==================================== [](#neuron-php-job-scheduler--queue) A lightweight job scheduler and queue system for PHP 8.4+. Schedule recurring tasks with cron expressions and process background jobs with a reliable queue system. Features -------- [](#features) - **Combined Runner**: Single command to run scheduler and worker together - **Job Scheduling**: Schedule recurring jobs with cron expressions - **Queue System**: Background job processing with retry logic - **Multiple Drivers**: Database, file, or synchronous execution - **Failed Job Management**: Track, retry, and monitor failed jobs - **Helper Functions**: Simple API for dispatching jobs Quick Start ----------- [](#quick-start) ``` # Install composer require neuron-php/jobs # Run the complete job system vendor/bin/neuron jobs:run ``` That's it! The `jobs:run` command handles both scheduled tasks and queued jobs. Installation ------------ [](#installation) ``` composer require neuron-php/jobs ``` Configure PSR-4 autoloading in composer.json: ``` { "autoload": { "psr-4": { "App\\": "src/" } } } ``` Directory Structure ------------------- [](#directory-structure) ``` ├── composer.json ├── config │ ├── neuron.yaml # Application configuration │ └── schedule.yaml # Job schedule configuration ├── src │ └── Jobs │ ├── MyScheduledJob.php │ └── MyQueuedJob.php └── vendor ``` Configuration ------------- [](#configuration) ### Application Configuration (neuron.yaml) [](#application-configuration-neuronyaml) ``` # Basic configuration system: timezone: America/New_York base_path: /path/to/app logging: destination: \Neuron\Log\Destination\File format: \Neuron\Log\Format\PlainText file: storage/logs/app.log level: debug # Queue configuration queue: driver: database # database, file, or sync default: default # Default queue name retry_after: 90 # Seconds before retrying failed jobs max_attempts: 3 # Maximum retry attempts backoff: 10 # Backoff multiplier for retries # Database configuration (for database driver) database: adapter: sqlite name: storage/database.sqlite # For MySQL/PostgreSQL: # adapter: mysql # host: localhost # port: 3306 # user: username # pass: password # charset: utf8mb4 ``` **Queue Drivers:** - **database**: Persistent queue in database (recommended for production) - **file**: File-based queue in storage directory - **sync**: Execute jobs immediately (for testing) Job Scheduling -------------- [](#job-scheduling) ### Schedule Configuration (config/schedule.yaml) [](#schedule-configuration-configscheduleyaml) ``` schedule: # Quick job - runs directly in scheduler cleanup_logs: class: App\Jobs\CleanupLogsJob cron: "0 2 * * *" # Daily at 2:00 AM args: max_age_days: 30 # Long-running job - dispatch to queue process_reports: class: App\Jobs\GenerateReportsJob cron: "0 8 * * 1" # Monday at 8:00 AM queue: reports # Dispatch to 'reports' queue args: report_type: weekly # High-priority job with specific queue send_notifications: class: App\Jobs\SendNotificationsJob cron: "*/15 * * * *" # Every 15 minutes queue: high-priority ``` **Configuration Options:** - `class`: Job class name (required) - `cron`: Cron expression for schedule (required) - `args`: Arguments passed to job (optional) - `queue`: Queue name for background processing (optional) **When to Use Queue Dispatch:** - **Without queue**: Quick jobs (< 1 second) that won't block scheduler - **With queue**: Long-running jobs requiring retries and monitoring ### Creating Scheduled Jobs [](#creating-scheduled-jobs) Jobs implement the `Neuron\Jobs\IJob` interface: ``` namespace App\Jobs; use Neuron\Jobs\IJob; use Neuron\Log\Log; class CleanupLogsJob implements IJob { public function getName(): string { return 'cleanup-logs'; } public function run(array $args = []): mixed { $maxAgeDays = $args['max_age_days'] ?? 30; Log::info("Cleaning up logs older than {$maxAgeDays} days"); // Your cleanup logic here $deletedCount = 0; return $deletedCount; } } ``` Running Jobs ------------ [](#running-jobs) The job system can be run in three different modes depending on your needs: ### 1. Combined Mode (Recommended) [](#1-combined-mode-recommended) Run both scheduler and queue worker together with a single command: ``` vendor/bin/neuron jobs:run ``` This is the **easiest way** to run the complete job system. It manages both the scheduler and worker in one process. **Options:** - `--schedule-interval=30` - Scheduler polling interval in seconds (default: 60) - `--queue=emails,default` - Queue(s) to process (default: default) - `--worker-sleep=5` - Worker sleep when queue is empty (default: 3) - `--worker-timeout=120` - Job timeout in seconds (default: 60) - `--max-jobs=100` - Max jobs before restarting worker (default: unlimited) **Examples:** ``` # Run with defaults (both scheduler and worker) vendor/bin/neuron jobs:run # Custom configuration vendor/bin/neuron jobs:run --schedule-interval=30 --queue=emails,notifications ``` ### 2. Scheduler Only [](#2-scheduler-only) Run just the scheduler for executing scheduled tasks: **Daemon Mode** (continuous polling): ``` # Poll every 60 seconds (default) vendor/bin/neuron jobs:schedule # Custom polling interval vendor/bin/neuron jobs:schedule --interval=30 ``` **Cron Mode** (single poll per invocation): Add to your system crontab: ``` * * * * * cd /path/to/app && vendor/bin/neuron jobs:schedule --poll ``` ### 3. Worker Only [](#3-worker-only) Run just the queue worker for processing background jobs: ``` # Process default queue vendor/bin/neuron jobs:work # Process specific queue vendor/bin/neuron jobs:work --queue=emails # Process multiple queues (priority order) vendor/bin/neuron jobs:work --queue=high,default,low # Custom options vendor/bin/neuron jobs:work --sleep=5 --timeout=120 --max-jobs=100 ``` **Worker Options:** - `--queue, -Q`: Queue(s) to process (comma-separated), default: `default` - `--once`: Process one job then exit - `--stop-when-empty`: Stop when no jobs available - `--sleep, -s`: Seconds to sleep when queue empty, default: `3` - `--max-jobs, -m`: Maximum jobs before stopping, default: `0` (unlimited) - `--timeout, -t`: Job timeout in seconds, default: `60` Queue Processing ---------------- [](#queue-processing) ### Dispatching Jobs to Queue [](#dispatching-jobs-to-queue) #### Using Helper Functions [](#using-helper-functions) ``` use App\Jobs\SendEmailJob; // Basic dispatch dispatch(new SendEmailJob(), [ 'to' => 'user@example.com', 'subject' => 'Welcome', 'body' => 'Welcome to our site!' ]); // Specific queue dispatch(new ProcessImageJob(), ['path' => '/tmp/image.jpg'], 'images'); // Delayed job (execute in 1 hour) dispatch(new SendReminderJob(), ['order_id' => 123], 'default', 3600); // Execute immediately (bypass queue) $result = dispatchNow(new ProcessDataJob(), ['data' => $data]); ``` #### Using QueueManager Directly [](#using-queuemanager-directly) ``` use Neuron\Jobs\Queue\QueueManager; use Neuron\Patterns\Registry; $queueManager = Registry::getInstance()->get('queue.manager'); // Dispatch to queue $jobId = $queueManager->dispatch( new SendEmailJob(), ['to' => 'user@example.com'], 'emails', 0 // Delay in seconds ); // Execute immediately $result = $queueManager->dispatchNow(new ProcessDataJob(), ['data' => $data]); ``` ### Creating Queued Jobs [](#creating-queued-jobs) Same as scheduled jobs - implement `IJob` interface: ``` namespace App\Jobs; use Neuron\Jobs\IJob; use Neuron\Log\Log; class SendEmailJob implements IJob { public function getName(): string { return 'send-email'; } public function run(array $args = []): mixed { $to = $args['to']; $subject = $args['subject']; $body = $args['body']; Log::info("Sending email to {$to}"); // Your email sending logic mail($to, $subject, $body); return true; } } ``` Queue Management ---------------- [](#queue-management) ### Monitor Queue Status [](#monitor-queue-status) ``` # Show statistics for default queue vendor/bin/neuron jobs:stats # Show statistics for specific queues vendor/bin/neuron jobs:stats --queue=emails,reports ``` ### Managing Failed Jobs [](#managing-failed-jobs) #### View Failed Jobs [](#view-failed-jobs) ``` vendor/bin/neuron jobs:failed ``` Shows: - Job ID - Queue name - Job class - Failure timestamp - Exception details #### Retry Failed Jobs [](#retry-failed-jobs) ``` # Retry specific job by ID vendor/bin/neuron jobs:retry 123 # Retry all failed jobs vendor/bin/neuron jobs:retry --all ``` #### Delete Failed Jobs [](#delete-failed-jobs) ``` # Delete specific failed job vendor/bin/neuron jobs:forget 123 ``` ### Clear Queues [](#clear-queues) ``` # Clear default queue vendor/bin/neuron jobs:flush # Clear specific queue vendor/bin/neuron jobs:flush --queue=emails # Clear all failed jobs vendor/bin/neuron jobs:flush --failed ``` Helper Functions ---------------- [](#helper-functions) ``` // Dispatch to queue dispatch(IJob $job, array $args = [], ?string $queue = null, int $delay = 0): string // Execute immediately dispatchNow(IJob $job, array $args = []): mixed // Get queue size queueSize(?string $queue = null): int // Clear queue clearQueue(?string $queue = null): int ``` More Information ---------------- [](#more-information) Learn more at [neuronphp.com](http://neuronphp.com) ### Health Score 43 ↑ FairBetter than 89% of packages Maintenance94 Actively maintained with recent releases Popularity21 Limited adoption so far Community12 Small or concentrated contributor base Maturity38 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~27 days Recently: every ~48 days Total 20 Last Release 28d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1099983?v=4)[Lee Jones](/maintainers/ljonesfl)[@ljonesfl](https://github.com/ljonesfl) --- Top Contributors [![ljonesfl](https://avatars.githubusercontent.com/u/1099983?v=4)](https://github.com/ljonesfl "ljonesfl (124 commits)") --- Tags cronjobsphp8scheduler ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/neuron-php-jobs/health.svg) ``` [![Health](https://phpackages.com/badges/neuron-php-jobs/health.svg)](https://phpackages.com/packages/neuron-php-jobs) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.8k543.8M20.1k](/packages/laravel-framework)[spatie/laravel-health Monitor the health of a Laravel application 87512.0M165](/packages/spatie-laravel-health)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.4M203](/packages/sulu-sulu)[roots/acorn Framework for Roots WordPress projects built with Laravel components. 9762.4M131](/packages/roots-acorn)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M574](/packages/shopware-core)[contao/core-bundle Contao Open Source CMS 1231.6M2.8k](/packages/contao-core-bundle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)