Weave Code
Notifications Laravel Package
escolalms/notifications
A Laravel notification package from EscolaLMS that adds a ready-made notification layer to your application, letting you send, store, and manage user alerts and messages through a consistent, framework-friendly API.
Main package of notification module which saves all notifications to database and allows to attach any other Template channels
Frequently asked questions about Notifications
- What is escolalms/notifications used for?
- It provides a ready-made notification layer for Laravel applications built on the Escola LMS platform. The package includes prebuilt notification classes for common LMS events such as courses, enrollments, and platform activity. It supports database and mail channels out of the box and can send notifications through queued delivery for scalability.
- How do I install escolalms/notifications with Composer?
- Install the package with composer require escolalms/notifications. It is a Laravel package, so it integrates with your existing application structure and user model. After installation, run any required migrations for database notifications and configure your queue worker if you use queued delivery.
- Which Laravel versions are compatible with escolalms/notifications?
- The package builds on Laravel's native notification system, so it follows standard Laravel notification conventions. Check the package's composer.json for the exact Laravel and PHP version constraints before installing. That is the most reliable way to confirm compatibility for your application.
- Does escolalms/notifications support queued notifications?
- Yes, the package supports queued delivery for scalable, asynchronous sending. Queuing keeps notification sending out of the request cycle, which is useful for LMS events that may affect many users. You will need a running queue worker in production to process those jobs.
- Which notification channels are supported out of the box?
- The package supports the database and mail channels out of the box. Database notifications let users see alerts inside your application, while mail sends them by email. Because it is built on Laravel's notification system, you can extend delivery with other Laravel-compatible channels when needed.
- How do I store user notifications in the database?
- Use the package's database channel support and make sure your application has the standard Laravel notifications table migration. Prebuilt notification classes can then persist alerts for users, who retrieve them through Laravel's notifications relationship. This is useful for in-app message centers and activity feeds.
- Can I customize the notification templates and messages?
- Yes, the package is designed with pluggable templates so you can keep messaging consistent while adapting content to your brand or LMS workflow. You can customize the rendered notification content used by the prebuilt classes. This helps avoid duplicating markup across course, enrollment, and platform event alerts.
- How do I test escolalms/notifications in my Laravel app?
- Because the package uses Laravel's native notification system, you can test it with Notification::fake() and standard assertion methods such as assertSentTo. This lets you verify that the correct notification classes are sent to the right users without actually sending mail or storing database records. You can also test queued notifications using Laravel's queue fakes.
- Do I need to change my User model to use escolalms/notifications?
- Your notifiable models should use Laravel's Notifiable trait, which is standard in Laravel applications. The package is designed for simple integration with existing user models, so you generally do not need to replace your authentication or user structure. Just ensure the models receiving notifications are set up as notifiable.
- What are alternatives to escolalms/notifications?
- The main alternative is Laravel's native notification system, where you write your own notification classes and channel logic. Other Laravel notification packages may offer broader channel support or UI components, but they will not include Escola LMS-specific prebuilt notifications. escolalms/notifications is most useful when you want ready-made LMS event notifications with database, mail, and queued delivery.
Weaver
How can I help you explore Laravel packages today?