indeev / laravel-schedule-calendar
Laravel Schedule Calendar - a package providing developers with a concise and visual representation of scheduled tasks, enabling easy analysis of load distribution throughout the day or week for optimized task scheduling.
Installs: 2 768
Dependents: 0
Suggesters: 0
Security: 0
Stars: 55
Watchers: 4
Forks: 3
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
Requires (Dev)
- orchestra/testbench: ^v6.40.0
README
Overview
The Schedule Calendar command has been introduced to provide developers with a clear and insightful view of scheduled tasks within the Laravel application. This new functionality allows for a visual representation of task distribution throughout the day and week, offering a valuable perspective on load distribution.
Requirements
- PHP 7.3 or higher
- Laravel 8+
Key Features
-
Day and Week View: Easily switch between day and week views to analyze scheduled tasks over different time frames.
-
Load Distribution: Gain insights into the distribution of scheduled tasks throughout the day, helping identify peak load periods and optimize task scheduling.
-
Enhanced Debugging: Use the calendar view as a debugging tool to identify potential conflicts or overlaps in scheduled tasks.
Installation
The Schedule Calendar command is available as a package on Packagist and can be installed using Composer.
composer require indeev/laravel-schedule-calendar
How to Use
To leverage the power of Schedule Calendar, simply run the command in your Laravel application:
php artisan schedule:calendar
This will generate a visual representation of your scheduled tasks, providing a comprehensive overview of your application's task schedule.
Display Option: --display=dot
The --display=dot option provides a visual representation of your scheduled tasks using dots, offering a clear and concise overview. Each dot represents all scheduled tasks in time piece, making it easy to identify the distribution of tasks throughout the specified time range.
Usage:
php artisan schedule:calendar --display=dot
Display Option: --display=list
The --display=list option provides a detailed list of concrete commands for each time piece, offering a comprehensive view of your scheduled activities.
Usage:
php artisan schedule:calendar --display=list
Range Option: --range=week
The --range=week option allows you to view scheduled tasks for the week around a specified day (or current day as default), providing a broader context of your upcoming activities.
Usage:
php artisan schedule:calendar --range=week
Date Selection Option: --day=YYYY-MM-DD
The --day=YYYY-MM-DD option allows you to specify a particular date for viewing the scheduled tasks, providing detailed insights into the tasks for that specific day.
Usage:
php artisan schedule:calendar --day=yyyy-mm-dd
Hours per line Option: --hoursPerLine
The --hoursPerLine option allows you to specify how many hours will be displayed per one output line. This parameter provides flexibility in tailoring the visual representation based on your preferences.
Usage:
php artisan schedule:calendar --hoursPerLine=6
php artisan schedule:calendar --hoursPerLine=24
Contribution
👋 Thank you for considering contributing to our project! We welcome contributions from the community to help make this project even better. Whether you're fixing a bug, improving documentation, or adding a new feature, your efforts are highly appreciated and will be credited.
Credits
License
The MIT License (MIT). Please see License File for more information.