Mandatory

• PHP 8.2+

• The JSON extension

Optional

• A PSR-3 (Logger Interface) implementation for debugging

Extension Specific

VAPID extension

• Required:

  • openssl extension

  • mbstring extension

  • A JWT Provider

  • A PSR-20 (Clock) implementation

• Optional:

  • A PSR-3 (Logger Interface) implementation for debugging

Payload extension

• Required:

  • openssl extension

  • mbstring extension

• Optional:

  • A PSR-6 (Caching Interface) implementation

  • A PSR-3 (Logger Interface) implementation for debugging

First of all, thank you for contributing.

Bugs or feature requests can be posted online on the GitHub issues section of the project.

Few rules to ease code reviews and merges:

• You MUST run the test suite (see below).

• You MUST write (or update) unit tests when bugs are fixed or features are added.

• You SHOULD write documentation.

We use the following branching workflow:

• Each minor version has a dedicated branch (e.g. v1.1, v1.2, v2.0, v2.1…)

• The default branch is set to the last minor version (e.g. v2.1).

Your PR should NOT be submitted to the master branch but to the last minor version branch or to another minor version in case of bug fix.

The Web Push protocol allows your application to easily engage users by sending notifications to the browser. The subscription to these notifications are done by the user (opt-in).

The notification types depend on the application. For example, it could be a notification for an internal message or an alert before account closure.

We will see in this documentation that the Web Push API offers several options to customize the notifications by adding buttons, vibration schema, images, urgency indictor and more.

In the documentation, you will see that methods are called “fluently”.

If you don’t adhere to this coding style, you are free to use the “standard” way of coding. The following example has the same behavior ase above.