Search…
The Extension Manager
The Web Push service requires an Extension Manager. This object manages extensions that will manipulate the request before sending it to the Push Service.
In the example below, we add all basic extensions.
1
use WebPush\ExtensionManager;
2
use WebPush\PreferAsyncExtension;
3
use WebPush\TopicExtension;
4
use WebPush\TTLExtension;
5
use WebPush\UrgencyExtension;
6
7
$extensionManager = ExtensionManager::create()
8
->add(TTLExtension::create())
9
->add(UrgencyExtension::create())
10
->add(TopicExtension::create())
11
->add(PreferAsyncExtension::create())
12
;
Copied!
Please note that the TTL Extension is usually required by Push Services. To avoid any trouble, please use all extensions.
Payload Extension
The payload extension allows Notifications to have a payload. This extension requires Content Encoding objects that will be responsible of the payload encryption.
The library provides the
AESGCM and AES128GCM content encoding. These encodings are normally supported by all Push Services. The library is able to support any future encoding is deemed necessary.1
$payloadExtension = PayloadExtension::create()
2
->addContentEncoding(AESGCM::create())
3
->addContentEncoding(AES128GCM::create())
4
;
5
6
$extensionManager = ExtensionManager::create()
7
->add($payloadExtension)
8
;
Copied!
VAPID Extension
The VAPID header authenticates your server and prevent malicious application to send notifications to your users. The header contains a signed JSON Web Token (JWS).
The library provides bridges for the following libraries
web-token and lcobucci/jwt.Please install
web-token/jwt-signature-algorithm-ecdsa or lcobucci/jwt depending on the library you want to use.1
use WebPush\VAPID\WebTokenProvider;
2
use WebPush\VAPID\LcobucciProvider;
3
4
// Web-Token
5
$jwsProvider = WebTokenProvider::create(
6
'BB4W1qfBi7MF_Lnrc6i2oL-glAuKF4kevy9T0k2vyKV4qvuBrN3T6o9-7-NR3mKHwzDXzD3fe7XvIqIU1iADpGQ', // Public key
7
'C40jLFSa5UWxstkFvdwzT3eHONE2FIJSEsVIncSCAqU' // Private key
8
);
9
10
// lcobucci/jwt
11
$jwsProvider = LcobucciProvider::create(
12
'BB4W1qfBi7MF_Lnrc6i2oL-glAuKF4kevy9T0k2vyKV4qvuBrN3T6o9-7-NR3mKHwzDXzD3fe7XvIqIU1iADpGQ',
13
'C40jLFSa5UWxstkFvdwzT3eHONE2FIJSEsVIncSCAqU'
14
);
15
16
$extensionManager = ExtensionManager::create()
17
->add(VAPIDExtension::create('http://my-service.com', $jwsProvider)
18
);
Copied!
The public key used with your server shall be the same as the one in your Javascript application.
If this public/private key changes, subscriptions will become invalid.
Last modified 5mo ago
Export as PDF
Copy link