Download the PHP package aa-engineering/laravel-scheduled-reminders without Composer
On this page you can find all versions of the php package aa-engineering/laravel-scheduled-reminders. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aa-engineering/laravel-scheduled-reminders
More information about aa-engineering/laravel-scheduled-reminders
Files in aa-engineering/laravel-scheduled-reminders
Package laravel-scheduled-reminders
Short Description A Laravel package for scheduling and managing reminders with morphable relationships
License MIT
Homepage https://github.com/aa-engineering-kft/laravel-scheduled-reminders
Informations about the package laravel-scheduled-reminders
Laravel Scheduled Reminders
A Laravel package for scheduling and managing reminders with morphable relationships. Schedule notifications to be sent at specific times, attach them to any model, and track their delivery status.
Features
- ๐ Schedule reminders for any date/time
- ๐ Polymorphic relationships - attach reminders to any model
- ๐ Track delivery status - know when reminders were sent
- ๐ฏ Source tracking - link reminders to their originating models (tasks, events, etc.)
- ๐งน Automatic pruning - clean up old sent reminders
- ๐จ Flexible data storage - store custom data with each reminder
- โก Queue support - send reminders via queue workers
- ๐งช Fully tested - comprehensive test suite included
Installation
You can install the package via composer:
Publish and run the migrations:
Optionally, publish the config file:
This is the contents of the published config file:
Usage
1. Add the trait to your models
Add the Remindable trait to any model that should receive reminders:
2. Create a reminder
3. Query reminders
4. Remove reminders
5. Send reminders
Set up a scheduled task in your routes/console.php:
Or manually send reminders:
6. Automatic pruning
Enable automatic pruning of sent reminders by adding to your routes/console.php:
Sent reminders older than the configured prune_after_days will be automatically deleted.
Advanced Usage
Custom Notification Data
You can store any custom data with your reminders:
Access the data in your notification:
Notification Constructor Patterns
The package supports flexible notification constructors. Here are all possible patterns:
1. Constructor with Source Only
2. Constructor with Source and Data
3. Constructor with Data Only
4. No Constructor Parameters
5. Constructor with Custom Parameters
Direct Model Access
You can also work with the Reminder model directly:
Using with Queues
Your notification classes can implement ShouldQueue as usual:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- AA Engineering Kft
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-scheduled-reminders with dependencies
illuminate/contracts Version ^11.0|^12.0|^13.0
illuminate/database Version ^11.0|^12.0|^13.0
illuminate/notifications Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0