Download the PHP package noerd/notifications without Composer
On this page you can find all versions of the php package noerd/notifications. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download noerd/notifications
More information about noerd/notifications
Files in noerd/notifications
Package notifications
Short Description In-app notifications for the noerd framework: a bell in the top bar with an unread badge, and one API every module sends through — a service call or a Laravel notification channel
License MIT
Homepage https://github.com/noerd-dev/notifications
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package notifications
noerd/notifications
An extension package for noerd/noerd, the
YAML-driven Livewire framework for multi-tenant Laravel applications. It plugs into the noerd
top bar and the noerd user and tenant model — it is not a standalone Laravel package and does
nothing without a noerd installation.
What it adds: in-app notifications for every app built on noerd — a bell in the top bar with a red badge for unread entries, a dropdown with the latest notifications, "Mark all as read", and a click that opens the notification's target. Every module of an application sends through one API — a service call, or a regular Laravel notification channel.
Features
- Bell in the top bar — registers itself on install, right of the quick menu; unread badge, the latest 20 entries, level colours (info, success, warning, error), relative timestamps in the reader's locale
- One API for every sender —
NotificationService::send()with an explicit user and tenant, so queued jobs and scheduled commands can notify without a signed-in user - A Laravel notification channel — return
NoerdChannel::classfromvia()and aNoerdMessagefromtoNoerd(); the same notification class may also send a mail - Targets without coupling — a notification points at a record (a route, with a component fallback) or at a page URL; the module never knows which module owns the target
- Per user, per tenant — a user only ever sees the notifications of the tenant they are working in; foreign notifications answer 404
- Extensible — a
NotificationSentevent after every write, a model factory for your tests, German translations, a prune command for old entries - No infrastructure — the bell polls every 30 seconds; no WebSockets, no broadcasting setup
Requirements
- A Laravel 12 or 13 application on PHP 8.3+ that runs the noerd framework:
noerd/noerd0.16+ installed and set up (composer require noerd/noerd && php artisan noerd:install). The package renders into noerd's top bar, authenticates against noerd's user guard and stores notifications per noerd tenant — there is nothing to hook into in a plain Laravel app
Installation
The install command runs the migration (one table, noerd_notifications). It registers no
tenant app and publishes no configuration — the bell appears in the top bar of every app as
soon as the package is installed.
Sending a notification
Through the service
| Argument | Meaning |
|---|---|
userId, tenantId |
The recipient and the tenant the notification belongs to — always explicit, never taken from the session |
title |
Shown in bold; stored already translated (translate with __() when sending) |
body |
Optional second line |
target |
Where a click leads (see below); null only marks the entry read |
level |
info (default), success, warning or error — decides the icon colour |
icon |
A heroicon name such as sparkles; an unknown name falls back to the bell |
type |
A free key of the sender (reports.finished) for filtering and statistics |
Through a Laravel notification
NoerdUser is Notifiable. A notification class that returns the channel from via() and a
NoerdMessage from toNoerd() is stored exactly like a service call — and may send a mail
through the regular channels at the same time:
Without a tenantId on the message the notifiable's currently selected tenant is used; a user
without a tenant receives nothing (there is no bell to show it in).
Targets
A NotificationTarget has three shapes:
| Shape | Behaviour on click |
|---|---|
route + arguments |
Opens the record as a modal through the named Route::livewire() route; the browser URL is rewritten to the record, so the notification stays shareable |
component + arguments |
Fallback when the route is not registered (the owning module is not installed): opens the component as a modal |
url |
Navigates to the page |
Pass route AND component for a record — the route wins when it exists, the component
keeps the click working otherwise. This is the Noerd::modalFor() contract of the framework.
Reacting to notifications
NoerdNotifications\Events\NotificationSent fires after every stored notification, with the
Notification model as $event->notification. Listen to it to add a channel the module does
not ship — a push message, a broadcast, a Slack post:
Housekeeping
Read notifications are kept until you prune them; unread ones stay until the user saw them.
Schedule the command in your routes/console.php:
Updating
The update command publishes nothing (the package ships no YAML and no config); it exists so
noerd:update-all covers the module.
Testing your own code
The model ships a factory:
Assert a sent notification with Notification::withoutGlobalScopes()->where('user_id', ...), or
fake the NotificationSent event with Event::fake().
Development
See AGENTS.md for contributor notes. Tests (Pest):
Format with vendor/bin/pint (from a host: vendor/bin/pint --config app-modules/noerd-notifications/pint.json app-modules/noerd-notifications).
License
MIT — see LICENSE.
