Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m14s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m12s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m7s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m19s
CI / PHP 8.3 / mysql:8.0 (pull_request) Successful in 1m32s
CI / PHP 8.4 / mysql:8.0 (pull_request) Successful in 1m22s
CI / PHP 8.4 / mysql:8.4 (pull_request) Successful in 1m32s
CI / PHP 8.3 / mysql:8.4 (pull_request) Successful in 1m35s
CI / Build-Artefakte aktuell (pull_request) Failing after 1m7s
- Laravel 13 mit Filament 5 (Admin), Inertia 3 + Vue 3 + Vuetify 4 (Material 3) - Anmeldung über Fortify (Login, Passwort vergessen/ändern), keine Selbstregistrierung - Profil mit Profilbild (WebP in festen Größen), Personenseiten, Header mit Avatar-Menü - Material-3-Farbschema aus der Primärfarbe, hell/dunkel/System pro Person - Basis-Branding (Portalname, Logo, Primärfarbe) im Admin unter „Erscheinungsbild“ - Benutzerverwaltung im Admin, Zugang vorläufig über is_admin - vendor/ (ohne Dev-Pakete) und Frontend-Build mitversioniert, Dev-Pakete in vendor-dev/ - PHPUnit-Tests gegen MySQL/MariaDB, Forgejo-CI-Matrix, Docker-Entwicklungsumgebung - VERSION, CHANGELOG.md und CONTRIBUTING.md mit Release-Ablauf Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
202 lines
5.8 KiB
Markdown
202 lines
5.8 KiB
Markdown
---
|
|
title: Database notifications
|
|
---
|
|
import Aside from "@components/Aside.astro"
|
|
import AutoScreenshot from "@components/AutoScreenshot.astro"
|
|
|
|
<AutoScreenshot name="notifications/database" alt="Database notifications" version="5.x" />
|
|
|
|
## Setting up the notifications database table
|
|
|
|
Before we start, make sure that the [Laravel notifications table](https://laravel.com/docs/notifications#database-prerequisites) is added to your database:
|
|
|
|
```bash
|
|
php artisan make:notifications-table
|
|
```
|
|
|
|
> If you're using PostgreSQL, make sure that the `data` column in the migration is using `json()`: `$table->json('data')`.
|
|
|
|
> If you're using UUIDs for your `User` model, make sure that your `notifiable` column is using `uuidMorphs()`: `$table->uuidMorphs('notifiable')`.
|
|
|
|
## Enabling database notifications in a panel
|
|
|
|
If you'd like to receive database notifications in a panel, you can enable them in the [configuration](../panel-configuration):
|
|
|
|
```php
|
|
use Filament\Panel;
|
|
|
|
public function panel(Panel $panel): Panel
|
|
{
|
|
return $panel
|
|
// ...
|
|
->databaseNotifications();
|
|
}
|
|
```
|
|
|
|
## Sending database notifications
|
|
|
|
There are several ways to send database notifications, depending on which one suits you best.
|
|
|
|
You may use our fluent API:
|
|
|
|
```php
|
|
use Filament\Notifications\Notification;
|
|
|
|
$recipient = auth()->user();
|
|
|
|
Notification::make()
|
|
->title('Saved successfully')
|
|
->sendToDatabase($recipient);
|
|
```
|
|
|
|
Or, use the `notify()` method:
|
|
|
|
```php
|
|
use Filament\Notifications\Notification;
|
|
|
|
$recipient = auth()->user();
|
|
|
|
$recipient->notify(
|
|
Notification::make()
|
|
->title('Saved successfully')
|
|
->toDatabase(),
|
|
);
|
|
```
|
|
|
|
> Laravel sends database notifications using the queue. Ensure your queue is running in order to receive the notifications.
|
|
|
|
Alternatively, use a traditional [Laravel notification class](https://laravel.com/docs/notifications#generating-notifications) by returning the notification from the `toDatabase()` method:
|
|
|
|
```php
|
|
use App\Models\User;
|
|
use Filament\Notifications\Notification;
|
|
|
|
public function toDatabase(User $notifiable): array
|
|
{
|
|
return Notification::make()
|
|
->title('Saved successfully')
|
|
->getDatabaseMessage();
|
|
}
|
|
```
|
|
|
|
## Moving the database notifications trigger to the panel sidebar
|
|
|
|
By default, the database notifications trigger is positioned in the topbar. If the topbar is disabled, it is added to the sidebar.
|
|
|
|
You can choose to always move it to the sidebar by passing a `position` argument to the `databaseNotifications()` method in the [configuration](../panel-configuration):
|
|
|
|
```php
|
|
use Filament\Enums\DatabaseNotificationsPosition;
|
|
use Filament\Panel;
|
|
|
|
public function panel(Panel $panel): Panel
|
|
{
|
|
return $panel
|
|
// ...
|
|
->databaseNotifications(position: DatabaseNotificationsPosition::Sidebar);
|
|
}
|
|
```
|
|
|
|
## Receiving database notifications
|
|
|
|
Without any setup, new database notifications will only be received when the page is first loaded.
|
|
|
|
### Polling for new database notifications
|
|
|
|
Polling is the practice of periodically making a request to the server to check for new notifications. This is a good approach as the setup is simple, but some may say that it is not a scalable solution as it increases server load.
|
|
|
|
By default, Livewire polls for new notifications every 30 seconds:
|
|
|
|
```php
|
|
use Filament\Panel;
|
|
|
|
public function panel(Panel $panel): Panel
|
|
{
|
|
return $panel
|
|
// ...
|
|
->databaseNotifications()
|
|
->databaseNotificationsPolling('30s');
|
|
}
|
|
```
|
|
|
|
You may completely disable polling if you wish:
|
|
|
|
```php
|
|
use Filament\Panel;
|
|
|
|
public function panel(Panel $panel): Panel
|
|
{
|
|
return $panel
|
|
// ...
|
|
->databaseNotifications()
|
|
->databaseNotificationsPolling(null);
|
|
}
|
|
```
|
|
|
|
### Using Echo to receive new database notifications with websockets
|
|
|
|
Websockets are a more efficient way to receive new notifications in real-time. To set up websockets, you must [configure it](broadcast-notifications#setting-up-websockets-in-a-panel) in the panel first.
|
|
|
|
Once websockets are set up, you can automatically dispatch a `DatabaseNotificationsSent` event by setting the `isEventDispatched` parameter to `true` when sending the notification. This will trigger the immediate fetching of new notifications for the user:
|
|
|
|
```php
|
|
use Filament\Notifications\Notification;
|
|
|
|
$recipient = auth()->user();
|
|
|
|
Notification::make()
|
|
->title('Saved successfully')
|
|
->sendToDatabase($recipient, isEventDispatched: true);
|
|
```
|
|
|
|
## Marking database notifications as read
|
|
|
|
There is a button at the top of the modal to mark all notifications as read at once. You may also add [Actions](overview#adding-actions-to-notifications) to notifications, which you can use to mark individual notifications as read. To do this, use the `markAsRead()` method on the action:
|
|
|
|
```php
|
|
use Filament\Actions\Action;
|
|
use Filament\Notifications\Notification;
|
|
|
|
Notification::make()
|
|
->title('Saved successfully')
|
|
->success()
|
|
->body('Changes to the post have been saved.')
|
|
->actions([
|
|
Action::make('view')
|
|
->button()
|
|
->markAsRead(),
|
|
])
|
|
->sendToDatabase($recipient);
|
|
```
|
|
|
|
Alternatively, you may use the `markAsUnread()` method to mark a notification as unread:
|
|
|
|
```php
|
|
use Filament\Actions\Action;
|
|
use Filament\Notifications\Notification;
|
|
|
|
Notification::make()
|
|
->title('Saved successfully')
|
|
->success()
|
|
->body('Changes to the post have been saved.')
|
|
->actions([
|
|
Action::make('markAsUnread')
|
|
->button()
|
|
->markAsUnread(),
|
|
])
|
|
->sendToDatabase($recipient);
|
|
```
|
|
|
|
## Opening the database notifications modal
|
|
|
|
You can open the database notifications modal from anywhere by dispatching an `open-modal` browser event:
|
|
|
|
```blade
|
|
<button
|
|
x-data="{}"
|
|
x-on:click="$dispatch('open-modal', { id: 'database-notifications' })"
|
|
type="button"
|
|
>
|
|
Notifications
|
|
</button>
|
|
```
|