Download the PHP package evtray/notifier without Composer
On this page you can find all versions of the php package evtray/notifier. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download evtray/notifier
More information about evtray/notifier
Files in evtray/notifier
Package notifier
Short Description Producer SDK for the SchoolAid notification pipeline (Kafka)
License MIT
Homepage https://github.com/evtray/notifier
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 notifier
schoolaid/notifier
Laravel producer SDK for the SchoolAid notification pipeline. Apps build immutable, validated payload DTOs and the package handles serialization, Kafka production, and audit logging. It is the single owner of the producer-side contract consumed by the schoolaid-notifications Go service.
Status: 0.1.0, pre-1.0. The payload contract may still change in minor versions.
docs/remains the normative spec; code and contract tests are the source of truth where they overlap.
Why this package exists
Today schoolaid-admin re-implements the notification payload shapes inside its message classes (toKafka() methods), which makes the contract implicit, undocumented drift-prone, and impossible to share. This package makes the contract explicit so that:
- marketaid can send notifications without re-implementing anything.
- schoolaid-admin can migrate off its bespoke Kafka plumbing.
- The payload shape is validated at build time and contract-tested against the Go service's JSON Schemas.
What it does / does not do
| In scope | Out of scope (stays in each app) |
|---|---|
Payload DTOs + builders for note.created, push.batch, email.batch |
Recipient resolution (who gets notified) |
| Build-time validation against the wire contract | Notification templates / localization of content |
| Kafka production (rdkafka), sync and queued | Legacy delivery paths (direct FCM/SMTP from Laravel) |
| Audit logging of every produced message | Retry/backfill business logic (reads the log, app-specific) |
Notifier::fake() test helpers |
Deciding when to notify |
Installation
The service provider and the Notifier facade are registered automatically via package discovery. The notification_logs migration is loaded from the package, so php artisan migrate is enough — publish it only if you need to edit it:
Kafka production stays off until you set NOTIFIER_ENABLED=true; while disabled, payloads are still built and validated but go to a NullProducer. See docs/configuration.md.
Quick start
Requirements
- PHP
^8.2 - Laravel
^11.0 | ^12.0 ext-rdkafkaat runtime when Kafka is enabled (suggested dependency, checked lazily)
Documentation
Everything lives in docs/README.md first — it tells you what to read for the task at hand.
