PHP Classes

PHP Web Push Notifications Server: Queue and push notifications to Web users

Recommend this page to a friend!
     
  Info   View files Example   View files View files (54)   DownloadInstall with Composer Download .zip   Reputation   Support forum (8)   Blog (2)    
Ratings Unique User Downloads Download Rankings
StarStarStarStar 79%Total: 1,995 This week: 8All time: 1,969 This week: 16Up
Version License PHP version Categories
pnserver 1.2.0Freely Distributable7.4Web services, PHP 7
Description 

Author

Stefan Kientzler

This package can queue and push notifications to Web users.

It can register the interest of users to receive notifications from the server by creating user subscriptions.

The package provides means to queue notification messages to be sent to users of an application by storing them in a database.

Then it can return queued messages, so they can be shown to Web uses on a Web page using custom JavaScript code that pulls the messages from the server using this package.

The package can also automatically delete expired messages and no longer valid subscriptions.

Recommendations

Push notifications for web browsers and now Apple iOS 16.4 pwa
I can’t find any packages that are current and work for webpush

Innovation Award
PHP Programming Innovation award winner
April 2020
Winner		 Web based push notifications are useful to let users of a site know about anything new that happens on a site that may be of the interest of those users.

This package provides a complete solution to register users interested to subscribe to get notifications from a site, queue notifications to be pushed to the users when they come to the site, and even perform maintenance on the notifications and subscriptions created by the users.

Manuel Lemos
Picture of Stefan Kientzler
  Performance   Level  
Name: Stefan Kientzler is available for providing paid consulting. Contact Stefan Kientzler .
Classes: 18 packages by
Country: Germany Germany
Age: 56
All time rank: 76649 in Germany Germany
Week rank: 11 Up1 in Germany Germany Up

Level 5 StarStarStarStarStar

 Innovation award
Innovation award
Nominee: 11x

Winner: 6x

Example

<?php
require_once 'autoloader.php';
require_once 'MyVapid.php';
require_once 'MyLogger.php';

use SKien\PNServer\PNDataProviderSQLite;
use SKien\PNServer\PNPayload;
use SKien\PNServer\PNServer;
use SKien\PNServer\PNSubscription;

/**
 * Example to send your push notifications.
 *
 * For easy setup we use the SQLite dataprovider and set the database file
 * located in the same directory as this script.
 *
 * First you should open PNTestClient.html in your browser and click the
 * [Subscribe] button to create a valis subscription in your database.
 *
 * Needed steps to send notification to all subscriptions stored in our database:
 * 1. Create and init dataprovider for database containing at least one valid subscription
 * 2. Set our VAPID keys (rename MyVapid.php.org to MyVapid.php ans set your own keys)
 * 3. Create and set the payload
 * 4. Load the subscriptions from the dataprovider
 * 5. And push the notification
 *
 * After the notification was pushed, a summary and/or a detailed log can be
 * retrieved from the server
 *
 * If you want to log several events or errors, you can pass any PSR-3 compliant
 * logger of your choice to the PNDataProvider- and PNServer-object.
 *
 * THIS CODE IS INTENDED ONLY AS EXAMPLE - DONT USE IT DIRECT IN YOU PROJECT
 *
 * @author Stefanius <s.kientzler@online.de>
 * @copyright MIT License - see the LICENSE file for details
 */

// check, if PHP version is sufficient and all required extensions are installed
$bExit = false;
if (version_compare(phpversion(), '7.4', '<')) {
    trigger_error('At least PHP Version 7.4 is required (current Version is ' . phpversion() . ')!', E_USER_WARNING);
    $bExit = true;
}
$aExt = array('curl', 'gmp', 'mbstring', 'openssl', 'bcmath');
foreach ($aExt as $strExt) {
    if (!extension_loaded($strExt)) {
        trigger_error('Extension ' . $strExt . ' must be installed!', E_USER_WARNING);
        $bExit = true;
    }
}
if ($bExit) {
    exit();
}

// for this test we use SQLite database
$logger = createLogger();
$oDP = new PNDataProviderSQLite(null, null, null, $logger);
if (!$oDP->isConnected()) {
    echo $oDP->getError();
    exit();
}

echo 'Count of subscriptions: ' . $oDP->count() . '<br/><br/>' . PHP_EOL;
if (!$oDP->init()) {
    echo $oDP->getError();
    exit();
}

// the server to handle all
$oServer = new PNServer($oDP);
$oServer->setLogger($logger);

// Set our VAPID keys
$oServer->setVapid(getMyVapid());

// create and set payload
// - we don't set a title - so service worker uses default
// - URL to icon can be
// * relative to the origin location of the service worker
// * absolute from the homepage (begining with a '/')
// * complete URL (beginning with https://)
$oPayload = new PNPayload('', "...first text to display.", './elephpant.png');
$oPayload->setTag('news', true);
$oPayload->setURL('/where-to-go.php');

$oServer->setPayload($oPayload);

// load subscriptions from database
if (!$oServer->loadSubscriptions()) {
    echo $oDP->getError();
    exit();
}

// ... and finally push !
if (!$oServer->push()) {
    echo '<h2>' . $oServer->getError() . '</h2>' . PHP_EOL;
} else {
    $aLog = $oServer->getLog();
    echo '<h2>Summary:</h2>' . PHP_EOL;
    $summary = $oServer->getSummary();
    echo 'total:&nbsp;' . $summary['total'] . '<br/>' . PHP_EOL;
    echo 'pushed:&nbsp;' . $summary['pushed'] . '<br/>' . PHP_EOL;
    echo 'failed:&nbsp;' . $summary['failed'] . '<br/>' . PHP_EOL;
    echo 'expired:&nbsp;' . $summary['expired'] . '<br/>' . PHP_EOL;
    echo 'removed:&nbsp;' . $summary['removed'] . '<br/>' . PHP_EOL;

    echo '<h2>Push - Log:</h2>' . PHP_EOL;
    foreach ($aLog as $strEndpoint => $aMsg ) {
        echo PNSubscription::getOrigin($strEndpoint) . ':&nbsp;' .$aMsg['msg'] . '<br/>' . PHP_EOL;
    }
}


  Files folder image Files  
File Role Description
Files folder imagePsr (1 directory)
Files folder imageSKien (2 directories)
Accessible without login Plain text file autoloader.php Aux. Auxiliary script
Accessible without login Image file elephpant.png Icon Icon image
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file MyLogger.php Example Example script
Accessible without login Plain text file MyVapid.php.org Example Example script
Accessible without login Plain text file phpstan.neon Data Auxiliary data
Accessible without login Plain text file phpunit.xml.org Data Auxiliary data
Accessible without login Plain text file PNClient.js Data Auxiliary data
Accessible without login Plain text file PNSendWelcome.php Example Example script
Accessible without login Plain text file PNServiceWorker.js Data Auxiliary data
Accessible without login Plain text file PNSubscriber.php Example Example script
Accessible without login Plain text file PNTestClient.html Data Example HTML page client
Accessible without login Plain text file PNTestPushSingle.php Example Example script
Accessible without login Plain text file PNTestServer.php Example Example script
Accessible without login Plain text file readme.md Doc. Documentation

  Files folder image Files  /  Psr  
File Role Description
Files folder imageLog (8 files)

  Files folder image Files  /  Psr  /  Log  
File Role Description
  Plain text file AbstractLogger.php Class Class source
  Plain text file InvalidArgumentException.php Class Class source
  Plain text file LoggerAwareInterface.php Class Class source
  Plain text file LoggerAwareTrait.php Class Class source
  Plain text file LoggerInterface.php Class Class source
  Plain text file LoggerTrait.php Class Class source
  Plain text file LogLevel.php Class Class source
  Plain text file NullLogger.php Class Class source

  Files folder image Files  /  SKien  
File Role Description
Files folder imagePNServer (9 files, 1 directory)
Files folder imageTest (1 directory)

  Files folder image Files  /  SKien  /  PNServer  
File Role Description
Files folder imageUtils (4 files)
  Plain text file PNDataProvider.php Class Class source
  Plain text file PNDataProviderMySQL.php Class Class source
  Plain text file PNDataProviderSQLite.php Class Class source
  Plain text file PNEncryption.php Class Class source
  Plain text file PNPayload.php Class Class source
  Plain text file PNServer.php Class Class source
  Plain text file PNServerHelper.php Class Class source
  Plain text file PNSubscription.php Class Class source
  Plain text file PNVapid.php Class Class source

  Files folder image Files  /  SKien  /  PNServer  /  Utils  
File Role Description
  Plain text file Curve.php Class Class source
  Plain text file Math.php Class Class source
  Plain text file NistCurve.php Class Class source
  Plain text file Point.php Class Class source

  Files folder image Files  /  SKien  /  Test  
File Role Description
Files folder imagePNServer (12 files, 1 directory)

  Files folder image Files  /  SKien  /  Test  /  PNServer  
File Role Description
Files folder imagetestdata (6 files)
  Plain text file PNDataProviderMySQLTest.php Class Class source
  Plain text file PNDataProviderSQLiteTest.php Class Class source
  Plain text file PNDataProviderTest.php Class Class source
  Plain text file PNEncryptionTest.php Class Class source
  Plain text file PNPayloadTest.php Class Class source
  Plain text file PNServerTest.php Class Class source
  Plain text file PNSubscriptionTest.php Class Class source
  Plain text file PNVapidTest.php Class Class source
  Plain text file TestHelperTrait.php Class Class source
  Plain text file UtilsCurveTest.php Class Class source
  Plain text file UtilsMathTest.php Class Class source
  Plain text file UtilsPointTest.php Class Class source

  Files folder image Files  /  SKien  /  Test  /  PNServer  /  testdata  
File Role Description
  Accessible without login Plain text file expired_subscription.json Data Auxiliary data
  Accessible without login Plain text file gone_subscription.json Data Auxiliary data
  Accessible without login Plain text file invalid_subscription.json Data Auxiliary data
  Accessible without login Plain text file inv_endpoint_subscription.json Data Auxiliary data
  Accessible without login Plain text file notfound_subscription.json Data Auxiliary data
  Accessible without login Plain text file valid_subscription.json Data Auxiliary data

Downloadpnserver-2021-09-25.zip 84KB
Downloadpnserver-2021-09-25.tar.gz 62KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:1,995
This week:8
All time:1,969
This week:16Up
User Ratings User Comments (1)
 All time
Utility:100%StarStarStarStarStarStar
Consistency:100%StarStarStarStarStarStar
Documentation:96%StarStarStarStarStar
Examples:100%StarStarStarStarStarStar
Tests:-
Videos:-
Overall:79%StarStarStarStar
Rank:30
  

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.