Crunz PHP Cron Job Manager

Crunz allows you to manage cron jobs through PHP code instead of manual crontab entries.

1. Define Tasks: Create PHP files (task files) using the Crunz\Schedule API to define what should run and when.
2. Single Cron Entry: Instead of many cron entries, you install one single cron job that runs every minute. This entry delegates task execution to the Crunz event runner.
3. Execution: The schedule:run command scans your task files and executes any tasks that are due to run at that specific minute.

# Add this to your crontab to run Crunz every minute
* * * * * cd /project && vendor/bin/crunz schedule:run

Crunz provides methods for specific days: mondays(), tuesdays(), wednesdays(), thursdays(), fridays(), saturdays(), and sundays().

Warning: These methods only modify the 'Day of Week' field of the cron expression. If used alone, the task will run every minute on that day. You should almost always combine them with a time constraint like at().

// CORRECT: Runs every Monday at 13:30
$task->mondays()->at('13:30');

// INCORRECT: Runs every minute on Mondays
$task->mondays();

When upgrading from v1.11 to v1.12, task files must always return an instance of extbackslash Crunz extbackslash Schedule. Returning an empty array or other types is no longer supported.

Correct task file pattern:

<?php

use Crunz	extbackslash Schedule;

$scheduler = new Schedule();

$scheduler
    ->run('php -v')
    ->description('PHP version')
    ->everyMinute();

return $scheduler;

When upgrading from v1.7 to v1.8, you must add a timezone key to your crunz.yml configuration file.

Example crunz.yml:

source: tasks
suffix: Tasks.php
timezone: Europe/Warsaw

As of v1.11, Crunz searches for its configuration (crunz.yml) relative to the current working directory (cwd), rather than relative to the vendor/bin/crunz binary location.

To ensure Crunz finds your configuration, you must cd into the project directory before executing commands.

CLI usage:

cd /var/www/project && vendor/bin/crunz schedule:list

Cron job configuration:

* * * * * cd /var/www/project && vendor/bin/crunz schedule:run

Crunz uses a YAML configuration file. Instead of modifying the package defaults, you should publish a local copy to your project root. Once published, Crunz will prioritize your local file over the internal one.

# Publish the configuration file to your project root
vendor/bin/crunz publish:config

Task files are PHP files that define one or more scheduled tasks.

Conventions:

• Directory: By default, Crunz looks for task files in the tasks/ directory at your project root. You can override this by passing a path to the schedule:run command.
• Naming: Filenames should ideally end with Tasks.php (e.g., GeneralTasks.php).
• Return Value: You must return the Crunz\Schedule instance at the end of the file, or the tasks in that file will be ignored.
• Organization: Crunz scans the directory recursively, so you can organize tasks into subdirectories.

<?php
// tasks/FirstTasks.php

use Crunz\Schedule;

$schedule = new Schedule();

$task = $schedule->run('cp project project-bk'); 
$task
    ->daily()
    ->description('Create a backup of the project directory.');

// IMPORTANT: You must return the schedule object
return $schedule; 

When upgrading from v3.2 to v3.3, the extbackslash Crunz extbackslash Schedule::run method requires all parameters in the arguments array to be strings. Do not pass booleans or integers directly.

Incorrect (v3.2):

$schedule->run('php', ['-v' => true, 2]);

Correct (v3.3+):

$schedule->run('php', ['-v' => '1', '2']);

$schedule = new Schedule();
$schedule->run('php', ['-v' => '1', '2']);

Install Crunz as a dependency in your PHP project using Composer. Once installed, a command-line utility named crunz will be available in your vendor/bin directory.

composer require crunzphp/crunz