Download the PHP package tobento/app-notifier without Composer
On this page you can find all versions of the php package tobento/app-notifier. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package app-notifier
App Notifier
Notifier support for the app using the Notifier Service.
Table of Contents
- Getting Started
- Requirements
- Documentation
- App
- Notifier Boot
- Notifier Config
- Creating And Sending Notifications
- Supported Channels
- Queuing Notifications
- Available Channels
- Storage Notification Formatters
- Custom Notifications
- Clear Notifications Command
- Credits
Getting Started
Add the latest version of the app notifier project running this command.
Requirements
- PHP 8.0 or greater
Documentation
App
Check out the App Skeleton if you are using the skeleton.
You may also check out the App to learn more about the app in general.
Notifier Boot
The notifier boot does the following:
- installs and loads notifier config file
- implements notifier interfaces
Notifier Config
The configuration for the notifier is located in the file at the default App Skeleton config location where you can specify the notification channels for your application.
Creating And Sending Notifications
Check out the Notifier Service - Creating And Sending Notifications section to learn more about it.
Supported Channels
By default, the following channels are supported:
-
Mail Channel, you will only need to configure your mailers in the Mail Config file.
-
Sms Channel - Vonage, you will only need to configure the dns in the Notifier Config file.
- Storage Channel
Queuing Notifications
Sending notifications can be a time-consuming task, you may queue notification messages for background sending to mitigate this issue.
To queue notification messages, simply add the Queue Parameter to your message:
Example
The App Queue Boot to support queuing messages out of the box.
You will only need to configure your queues in the Queue Config file.
Available Channels
The available channels may be used to restrict channels for certain services or to display its names and/or titles. By default all channels specified in the file will be available.
Storage Notification Formatters
Storage notification formatters may be used to format notifications stored by the Storage Channel.
General Formatter
You may use the general formatter which uses the following storage message data:
In :
The and data will used to generate the message url if you have installed the App Http - Routing Boot.
The and data will be translated by the formatter if you have installed the App Translation Boot.
General Formatter Example
You may create your own general formatter for notifications:
In :
Specific Formatter Example
You may create a specific formatter to format specific notifications only:
In :
Custom Notifications
You may easily customize notifications by defining them in the file:
Creating Custom Notification
Creating Notification Factory
Clear Notifications Command
If you have installed the App Console you may clear all notifications from channels which supports it such as storage channels using the command.
Clearing all notifications from all supported channels
Clearing all notifications from all specific channels
Available Options
Option | Description |
---|---|
The name(s) of the channel(s). | |
Clears only notifications that are read. | |
Clears only notifications that are unread. | |
The number of days after which to clear notifications. |
Credits
- Tobias Strub
- All Contributors
All versions of app-notifier with dependencies
tobento/app Version ^1.0.7
tobento/app-migration Version ^1.0
tobento/app-queue Version ^1.0
tobento/app-mail Version ^1.0
tobento/app-database Version ^1.0
tobento/service-collection Version ^1.0
tobento/service-autowire Version ^1.0.9
tobento/service-clock Version ^1.0
tobento/service-notifier Version ^1.0
tobento/service-repository-storage Version ^1.0
symfony/vonage-notifier Version ^6.0
psr/container Version ^2.0