frostiede/webpush-bundle

Send push notifications through Web Push Protocol to your Symfony users.

0.7 2021-05-13 15:57 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• ext-openssl: *
• guzzlehttp/guzzle: ^7.0
• minishlink/web-push: ^6.0
• symfony/http-kernel: ^4.4|^5.0

Requires (Dev)

• doctrine/common: ^2.0
• doctrine/dbal: ~2.5
• nyholm/symfony-bundle-test: ~1.4
• phpunit/phpunit: ^8.5
• symfony/config: ^4.4|^5.0
• symfony/dependency-injection: ^4.4|^5.0
• symfony/framework-bundle: ^4.4|^5.0
• symfony/http-foundation: ^4.4|^5.0
• symfony/routing: ^4.4|^5.0
• symfony/security: ^4.4|^5.0
• symfony/serializer: ^4.4|5.0
• symfony/var-dumper: ^4.4|^5.0
• symfony/yaml: ^4.4|^5.0
• twig/twig: ~1.0|~2.0

MIT

• Beno!t POLASZEK

• browser
• notifications
• subscription
• notification
• push
• chrome
• push notification
• push notifications
• subscriptions
• flex
• notification bundle
• firefox
• WebPush
• FCM
• Web Push
• vapid
• web push notification
• notifications bundle
• symfony notifications
• web push notifications
• push subscription
• PushNotification
• PushNotification bundle
• PushSubsciption
• PushSubsciption bundle
• subscription bundle
• subscriptions bundle
• push bundle
• push notification bundle
• push notifications bundle
• push subscription bundle
• push subscriptions
• push subscriptions bundle
• webpush protocol
• webpush bundle
• webpush notification
• webpush notification bundle
• webpush notifications
• webpush notifications bundle
• webpush subscription
• webpush subscription bundle
• webpush subscriptions
• webpush subscriptions bundle
• web push protocol
• web push bundle
• web push notification bundle
• web push notifications bundle
• web push subscription
• web push subscription bundle
• web push subscriptions
• web push subscriptions bundle
• symfony PushNotification
• symfony PushNotification bundle
• symfony PushSubsciption
• symfony PushSubsciption bundle
• symfony notification
• symfony notification bundle
• symfony notifications bundle
• symfony subscription
• symfony subscription bundle
• symfony subscriptions
• symfony subscriptions bundle
• symfony push
• symfony push bundle
• symfony push notification
• symfony push notification bundle
• symfony push notifications
• symfony push notifications bundle
• symfony push subscription
• symfony push subscription bundle
• symfony push subscriptions
• symfony push subscriptions bundle
• symfony webpush
• symfony webpush bundle
• symfony webpush notification
• symfony webpush notification bundle
• symfony webpush notifications
• symfony webpush notifications bundle
• symfony webpush subscription
• symfony webpush subscription bundle
• symfony webpush subscriptions
• symfony webpush subscriptions bundle
• symfony web push
• symfony web push bundle
• symfony web push notification
• symfony web push notification bundle
• symfony web push notifications
• symfony web push notifications bundle
• symfony web push subscription
• symfony web push subscription bundle
• symfony web push subscriptions
• symfony web push subscriptions bundle

README

Webpush Bundle

This bundle allows your app to leverage the Web Push protocol to send notifications to your users' devices, whether they're online or not.

With a small amount of code, you'll be able to associate your Symfony users to WebPush Subscriptions:

• A single user can subscribe from multiple browsers/devices
• Multiple users can subscribe from a single browser/device

This bundle uses your own persistence system (Doctrine or anything else) to manage these associations.

We assume you have a minimum knowledge of how Push Notifications work, otherwise we highly recommend you to read Matt Gaunt's Web Push Book.

Example Use cases

• You have a todolist app - notify users they're assigned a task
• You have an eCommerce app:
  • Notify your customer their order has been shipped
  • Notify your category manager they sell a product

Summary

1. Installation
2. The UserSubscription entity
3. The UserSubscription manager
4. Configure the bundle
5. Enjoy!
6. F.A.Q.

Getting started

This bundle is just the back-end part of the subscription process. For the front-end part, have a look at the webpush-client package.

Composer is your friend:

PHP7.1+ is required.

composer require bentools/webpush-bundle 0.6.*

If you're using Symfony 3, add the bundle to your kernel. With Symfony Flex, this should be done automatically.

⚠️ We aren't on stable version yet - expect some changes.

Generate your VAPID keys:

php bin/console webpush:generate:keys

You'll have to update your config with the given keys. We encourage you to store them in environment variables or in parameters.yml.

Next: Create your UserSubscription class

Tests

./vendor/bin/phpunit

License

MIT

Credits

This bundle leverages the minishlink/web-push library.