README

A Laravel package for managing scheduled tasks through file storage, allowing dynamic configuration of Laravel's task scheduler without code changes.

Features

• Manage scheduled tasks without modifying code
• Store task configurations in JSON files
• Toggle tasks on/off without deployment
• Add custom parameters and constraints to scheduled tasks
• Command-line interface for task management
• No database dependencies required

Requirements

• PHP 8.1 or higher
• Laravel 10.0 or higher

Installation

You can install the package via composer:

composer require trogers1884/laravel-schedule-mgt

The package will automatically register its service provider.

Configuration

Publish the configuration file:

php artisan vendor:publish --tag="schedule-mgt-config"

This will create a config/schedule-mgt.php file with the following contents:

return [
    'storage_path' => storage_path('app/schedule-mgt'),
    'file_format' => 'json',
];

Laravel Version-Specific Setup

Laravel 11

Add to your routes/console.php:

use Trogers1884\LaravelScheduleMgt\ScheduleManager;

ScheduleManager::schedule();

Laravel 10

Add to your app/Console/Kernel.php in the schedule method:

use Trogers1884\LaravelScheduleMgt\ScheduleManager;

protected function schedule(Schedule $schedule)
{
    ScheduleManager::schedule();
}

Important Notes

• For Laravel 10 and above, ensure your config/app.php has the package service provider if it's not auto-discovered:

  'providers' => [
      // ...
      Trogers1884\LaravelScheduleMgt\ScheduleMgtServiceProvider::class,
  ],

Usage

Managing Tasks via Console Commands

List All Tasks

php artisan schedule:list

Add a New Task

phpphp artisan schedule:add "command:name" \    # Note: The first argument is now 'task' internally
    --frequency=daily \
    --parameters='["--param1", "value1"]' \
    --freq-parameters='["21:00"]' \
    --constraints='[{"method":"environments", "parameters":["production"]}]'

Options:

• First argument: The artisan command to schedule
• --frequency: The scheduling frequency (daily, hourly, weekly, etc.)
• --parameters: JSON array of command parameters
• --freq-parameters: JSON array of frequency method parameters
• --constraints: JSON array of additional scheduling constraints
• --inactive: Set the task as inactive initially

Toggle Task Status

php artisan schedule:toggle 1 --active=0

Remove a Task

php artisan schedule:remove 1

This will completely remove the task with ID 1. You'll be asked to confirm before the task is removed. This action cannot be undone.

Frequency Methods

You can use any of Laravel's schedule frequency methods:

• hourly()
• daily()
• weekly()
• monthly()
• quarterly()
• yearly()
• timezone()
• at()
• dailyAt()
• twiceDaily()
• weeklyOn()
• monthly()
• monthlyOn()
• lastDayOfMonth()
• quarterly()
• yearly()
• cron()
• everyMinute()
• everyTwoMinutes()
• everyThreeMinutes()
• everyFourMinutes()
• everyFiveMinutes()
• everyTenMinutes()
• everyFifteenMinutes()
• everyThirtyMinutes()

Available Constraints

You can add any of Laravel's schedule constraints:

• environments(['production'])
• evenInMaintenanceMode()
• withoutOverlapping()
• onOneServer()
• between('8:00', '17:00')
• unlessBetween('23:00', '4:00')
• when(closure)
• skip(closure)
• runInBackground()

Example Tasks

Basic Daily Task

php artisan schedule:add "cache:clear" --frequency=daily

Weekly Backup with Parameters

php artisan schedule:add "backup:run" \
    --frequency=weekly \
    --freq-parameters='["monday", "3:00"]' \
    --parameters='["--only-db"]' \
    --constraints='[{"method":"environments", "parameters":["production"]}]'

Hourly Task with Multiple Constraints

php artisan schedule:add "queue:work" \
    --frequency=hourly \
    --constraints='[
        {"method":"withoutOverlapping"},
        {"method":"environments", "parameters":["production"]},
        {"method":"evenInMaintenanceMode"},
        {"method":"runInBackground"}
    ]'

Testing the Package

Run the test suite:

composer test

Uninstallation

To completely remove the package from your Laravel project:

1. Remove your schedule configuration from your Laravel project:

• For Laravel 11: Remove the ScheduleManager::schedule(); line from routes/console.php
• For Laravel 10: Remove the ScheduleManager::schedule(); line from app/Console/Kernel.php

1. Remove the published configuration file:

rm config/schedule-mgt.php

1. Remove the stored task data (optional):

rm -rf storage/app/schedule-mgt

1. Uninstall the package via composer:

composer remove trogers1884/laravel-schedule-mgt

Security

If you discover any security related issues, please use the issue tracker located at https://github.com/trogers1884/laravel-schedule-mgt/issues .

Credits

• Tom Rogers
• All Contributors

License

The MIT License (MIT). Please see License File for more information.