web-push-php

This library does not support Firebase Cloud Messaging (FCM).

While the Legacy HTTP protocol used by FCM and Web Push with VAPID share the same endpoint URL (https://fcm.googleapis.com/fcm/send), they are different protocols. Support for the outdated FCM subscription has been removed. Web Push with VAPID remains available at that URL and requires no action.

To send push notifications, you can either queue multiple notifications and then flush them all at once, or send a single notification immediately.

1. Queueing: Use queueNotification($subscription, $payload) to add notifications to a queue. Then, call flush() to send them. flush() returns a generator of MessageSentReport objects.
2. Single Send: Use sendOneNotification($subscription, $payload) to send a single notification and get a MessageSentReport immediately.

Subscriptions can be created from a JSON object (the result of calling .toJSON() on a client-side PushSubscription) using Subscription::create().

If you are using a major PHP framework, there are existing bundles available:

Symfony:

• MinishlinkWebPushBundle
• bentools/webpush-bundle (for associating users to WebPush subscriptions)

Laravel:

• laravel-notification-channels/webpush

WordPress:

• Perfecty Push Notifications plugin

You can generate uncompressed public and secret keys using OpenSSL in a Linux bash environment:

$ openssl ecparam -genkey -name prime256v1 -out private_key.pem
$ openssl ec -in private_key.pem -pubout -outform DER|tail -c 65|base64|tr -d '=' |tr '/+' '_-' >> public_key.txt
$ openssl ec -in private_key.pem -outform DER|tail -c +8|head -c 32|base64|tr -d '=' |tr '/+' '_-' >> private_key.txt

Alternatively, you can use the PHP helper function:

var_dump(VAPID::createVapidKeys());

Note: On the client-side, you must subscribe using the VAPID public key as the applicationServerKey.

To handle high volumes of push notifications, follow these scaling strategies:

1. Enable MultiCurl: Ensure the MultiCurl extension is available on your server to allow concurrent requests.
2. Use Async Adapters: Install an HTTPlug async adapter, such as php-http/guzzle7-adapter, to improve non-blocking request handling.
3. Optimize Batch Sizes: Adjust the batch size via defaultOptions or by passing it as a parameter to the flush() method.
4. Use Concurrent Requests: Use flushPooled() instead of flush(). The flushPooled() method uses concurrent requests, which can significantly accelerate the process and often double the speed of requests.

WebPush is PSR-18 and PSR-17 compliant. It uses php-http/discovery to auto-detect a client (like Guzzle or Symfony HttpClient) if none is provided.

To use a specific client configuration (e.g., custom timeouts or proxies), instantiate your own PSR-18 client and pass it to the WebPush constructor.

To enable concurrent sending via flushPooled(), you must install an HTTPlug async client adapter (e.g., php-http/guzzle7-adapter) so that an Http\Client\HttpAsyncClient is available.

VAPID (RFC8292) is required to authenticate your server with push services. You must provide a subject (an email starting with mailto: or an https:// URL) and your VAPID keys.

When instantiating WebPush, you can pass authentication details in the $auth array using one of three methods:

1. Direct Keys: Provide publicKey and privateKey (Base64-URL encoded).
2. PEM File: Provide a path to a .pem file via pemFile.
3. PEM Content: Provide the raw string content of a PEM file via pem.

To improve performance when sending multiple notifications to the same service, call $webPush->setReuseVAPIDHeaders(true) to reuse the same JWT token for the session.

$auth = [
    'VAPID' => [
        'subject' => 'mailto:me@website.com',
        'publicKey' => '~88 chars',
        'privateKey' => '~44 chars',
    ],
];

$webPush = new WebPush($auth);

Install the library and its dependencies using Composer by running the following command in your terminal:

composer require minishlink/web-push

To use the latest version of WebPush, you must have PHP 8.2+ installed along with the following PHP extensions:

• mbstring
• curl
• openssl (must have elliptic curve support)
• bcmath and/or gmp (optional, but highly recommended for better performance)

If you encounter the error SSL certificate problem: unable to get local issuer certificate, your PHP installation is missing necessary certificates.

To fix this:

1. Download cacert.pem from https://curl.haxx.se/ca/cacert.pem.
2. Edit your php.ini file. After the [curl] section, add the following line pointing to your downloaded file: curl.cainfo = /path/to/cacert.pem