This is the official PubNub PHP SDK repository.
PubNub takes care of the infrastructure and APIs needed for the realtime communication layer of your application. Work on your app's logic and let PubNub handle sending and receiving data across the world in less than 100ms.
The SDK supports PHP 7.4 and 8.x.
You will need the publish and subscribe keys to authenticate your app. Get your keys from the Admin Portal.
Integrate the PHP SDK into your project:
Without composer
Clone the following repository: git clone https://github.com/pubnub/php.git ./pubnub-php
Copy the src
folder to your project.
Include autoloader.php
file in your project:
require_once('src/autoloader.php');
Download dependency monolog
from https://github.com/Seldaek/monolog and copy the monolog
folder from the src
folder to the src
folder of your project.
Download dependency psr/Log
from https://github.com/php-fig/log/tree/master and copy the psr
folder to the src
folder of your project.
Download dependency rmccue
from https://github.com/WordPress/Requests and copy the Requests
folder and the file Requests.php
from the library
folder to the src
folder of your project.
With composer
Add the PubNub package to your composer.json
file:
{
"require": {
<!-- include the latest version from the badge at the top -->
"pubnub/pubnub": "7.0.0"
}
}
Run composer install --no-dev
from the command line. This installs the PubNub PHP SDK and all its dependencies in the vendor
folder of the project.
Include autoload.php
file in your project:
require_once('vendor/autoload.php');
Configure your keys:
$pnconf = new PNConfiguration();
$pubnub = new PubNub($pnconf);
$pnconf->setSubscribeKey("mySubscribeKey");
$pnconf->setPublishKey("myPublishKey");
$pnconf->setUserId("ReplaceWithYourClientIdentifier");
class MySubscribeCallback extends SubscribeCallback {
function status($pubnub, $status) {
if ($status->getCategory() === PNStatusCategory::PNUnexpectedDisconnectCategory) {
// This event happens when radio / connectivity is lost
} else if ($status->getCategory() === PNStatusCategory::PNConnectedCategory){
// Connect event. You can do stuff like publish, and know you'll get it // Or just use the connected event to confirm you are subscribed for // UI / internal notifications, etc
} else if ($status->getCategory() === PNStatusCategory::PNDecryptionErrorCategory){
// Handle message decryption error. Probably client configured to // encrypt messages and on live data feed it received plain text.
}
}
function message($pubnub, $message){
// Handle new message stored in message.message
}
function presence($pubnub, $presence){
// handle incoming presence data
}
}
$subscribeCallback = new MySubscribeCallback();
$pubnub->addListener($subscribeCallback);
$pubnub->subscribe()
->channels("hello_world")
->execute();
$pubnub->publish()
->channel("hello_world")
->message("Hello PubNub!")
->sync();
If you need help or have a general question, contact support@pubnub.com.