Configuration API for PHP SDK

Complete API reference for building real-time applications on PubNub with the PHP Software Development Kit (SDK). This page covers configuration, initialization, and event handling with concise, working examples.

Configuration

PNConfiguration stores user-provided settings that control PubNub client behavior. It includes additional properties for precise client configuration.

Immutable configuration

Once a configuration object has been passed to the PubNub constructor, you can't change its properties.

Although we don't recommend it, you can enable changing the configuration object after using it to create a PubNub instance, by calling the disableImmutableCheck() method just before passing it to the PubNub constructor.

use PubNub\PNConfiguration;
use PubNub\PubNub;

$config = new PNConfiguration();
$config->setPublishKey('demo');
$config->setSubscribeKey('demo');
$config->setUserId('demo');
// not recommended, disables config immutability
$config->disableImmutableCheck();

$pn = new PubNub($config);

Method(s)

To create a configuration instance, use the following constructor in the PHP SDK:

new PNConfiguration();

* required

Parameter	Description
`subscribeKey` * Type: String Default: n/a	`subscribeKey` from Admin Portal
`publishKey` Type: String Default: `null`	`publishKey` from Admin Portal (only required if publishing)
`secretKey` Type: String Default: `null`	`secretKey` (only required for modifying/revealing access permissions)
`UserId` * Type: String Default: n/a	`UUID` to use. You should set a unique `UUID` to identify the user or the device that connects to PubNub. It's a UTF-8 encoded string of up to 92 alphanumeric characters. If you don't set the `UUID`, you won't be able to connect to PubNub.
`authKey` Type: String Default: `null`	If Access Manager is utilized, client will use this `authKey` in all restricted requests.
`ssl` Type: Boolean Default: `true`	Use Secure Sockets Layer (SSL).
`connectTimeout` Type: Integer Default: `10`	How long to wait before giving up connection to client. The value is in seconds.
`subscribeTimeout` Type: Integer Default: `310`	How long to keep the `subscribe` loop running before disconnect. The value is in seconds.
`nonSubscribeRequestTimeout` Type: Integer Default: `10`	On `non subscribe` operations, how long to wait for server response. The value is in seconds.
`filterExpression` Type: String Default: `null`	Feature to subscribe with a custom filter expression.
`origin` Type: String Default: `ps.pndsn.com`	Custom `origin` if needed. To request a custom domain, contact support and follow the request process.
`cipherKey` Type: String Default: `null`	If `cipherKey` is passed, all communications to/from PubNub will be encrypted.
`useRandomIV` Type: Boolean Default: `true`	When `true` the initialization vector (IV) is random for all requests (not just for file upload). When `false` the IV is hard-coded for all requests except for file upload.
`client` Type: `ClientInterface` Default: Guzzle HTTP client	Custom HTTP client implementing PSR-18. If not set, the default Guzzle client is used. For more information on implementing a custom HTTP client, refer to PHP 8.0.0 migration guide.
`crypto` Type: `PubNubCryptoCore` Default: n/a	The cryptography module used for encryption and decryption of messages and files. Takes the `cipherKey` and `useRandomIV` parameters as arguments. For detailed encryption configuration and examples, refer to the Encryption API page.

Disabling random initialization vector

Disable random initialization vector (IV) only for backward compatibility (<4.3.0) with existing applications. Never disable random IV on new applications.

`crypto` module

crypto encrypts and decrypts messages and files. From 6.1.0, you can configure the algorithms it uses.

Each SDK includes two options: legacy 128-bit encryption and recommended 256-bit AES-CBC. For background, see Message Encryption.

For configuration details, examples, and partial encryption methods, see Encryption.

Legacy encryption with 128-bit cipher key entropy

You don't have to change your encryption configuration if you want to keep using the legacy encryption. If you want to use the recommended 256-bit AES-CBC encryption, you must explicitly set that in PubNub config.

Sample code

Required User ID

Always set the UserId to uniquely identify the user or device that connects to PubNub. This UserId should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UserId, you won't be able to connect to PubNub.

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

<?php

// Include Composer autoloader (adjust path if needed)
require_once 'vendor/autoload.php';

use PubNub\PNConfiguration;
use PubNub\PubNub;
use PubNub\CryptoModule;

// Create a new configuration instance
$pnConfiguration = new PNConfiguration();

// Set subscribe key (required)
$pnConfiguration->setSubscribeKey("demo");

show all 68 lines

Rest response from server

Returns a client configuration that is ready to use.

Initialization

Add PubNub to your project using the steps in the Getting Started guide.

Use PHP SDK in your code

use PubNub\PubNub;

PEM files can be downloaded for the domains pubsub.pubnub.com, pubsub.pubnub.net and ps.pndsn.com using the commands:

echo Q | openssl s_client -connect pubsub.pubnub.com:443 -servername pubsub.pubnub.com -showcerts
echo Q | openssl s_client -connect pubsub.pubnub.net:443 -servername pubsub.pubnub.net -showcerts
echo Q | openssl s_client -connect ps.pndsn.com:443 -servername ps.pndsn.com -showcerts

Set verify_peer to true to use the PEM files.

Description

This function initializes the PubNub Client API context. Call it before using any APIs to establish account-level credentials such as publishKey and subscribeKey.

Method(s)

To Initialize PubNub you can use the following method(s) in the PHP SDK:

new PubNub($pnconf);

* required

Parameter	Description
`pnConfiguration` * Type: PNConfiguration	Go to Configuration for more details.

Sample code

Initialize the PubNub client API

Required User ID

use PubNub\PNConfiguration;
use PubNub\PubNub;

$pnconf = new PNConfiguration();

$pnconf->setSubscribeKey("my-key");
$pnconf->setPublishKey("my-key");
$pnconf->setSecure(false);
$pnconf->setUserId("myUniqueUserId");
$pubnub = new PubNub($pnconf);

Returns

Returns a PubNub instance for APIs like publish(), subscribe(), history(), and hereNow().

Other examples

Initialize a non-secure client

Required User ID

use PubNub\PNConfiguration;
use PubNub\PubNub;

$pnConfiguration = new PNConfiguration();

$pnConfiguration->setSubscribeKey("my_sub_key");
$pnConfiguration->setPublishKey("my_pub_key");
$pnConfiguration->setSecure(false);
$pnConfiguration->setUserId("myUniqueUserId");
$pubnub = new PubNub($pnConfiguration);

Initialization for a Read-Only client

In the case where a client will only read messages and never publish to a channel, you can simply omit the publishKey when initializing the client:

Required User ID

use PubNub\PNConfiguration;
use PubNub\PubNub;

$pnConfiguration = new PNConfiguration();

$pnConfiguration->setSubscribeKey("my_sub_key");

$pubnub = new PubNub($pnConfiguration);

Use a custom UUID

Set a custom UserId to identify your users.

Required User ID

use PubNub\PNConfiguration;
use PubNub\PubNub;

$pnconf = new PNConfiguration();

$pnconf->setSubscribeKey("mySubscribeKey");
$pnconf->setPublishKey("myPublishKey");
$pnconf->setUserId("myUniqueUserId");

$pubnub = new PubNub($pnconf);

Initializing with Access Manager

Requires Access Manager add-on

This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Secure your secretKey

Anyone with the secretKey can grant and revoke permissions to your app. Never let your secret key be discovered, and to only exchange it / deliver it securely. Only use the secretKey on secure server-side platforms.

When you init with secretKey, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.

For applications that will administer Access Manager permissions, the API is initialized with the secretKey as in the following example:

Required User ID

use PubNub\PNConfiguration;
use PubNub\PubNub;

$pnConfiguration = new PNConfiguration();

$pnConfiguration->setSubscribeKey("my_sub_key");
$pnConfiguration->setPublishKey("my_pub_key");
$pnConfiguration->setSecretKey("my_secret_key");
$pnConfiguration->setUserId("myUniqueUserId");
$pubnub = new PubNub($pnConfiguration);

Now that the pubnub object is instantiated the client will be able to access the Access Manager functions. The pubnub object will use the secretKey to sign all Access Manager messages to the PubNub Network.

Event listeners

Listeners notify your app about connection status, messages, and presence events.

Add listeners before you call methods.

Add listeners

use PubNub\PubNub;
use PubNub\Enums\PNStatusCategory;
use PubNub\Callbacks\SubscribeCallback;
use PubNub\PNConfiguration;

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.
        }
    }
show all 47 lines

Remove listeners

$subscribeCallback = new MySubscribeCallback();

$pubnub->addListener($subscribeCallback);

// some time later
$pubnub->removeListener($subscribeCallback);

Listener status events

Category	Description
`PNConnectedCategory`	SDK subscribed with a new mix of channels (fired every time the `channel` / `channel group` mix changed).
`PNAccessDeniedCategory`	Request failed because of access error (active Access Manager). `status.errorData.channels` or `status.errorData.channelGroups` contain list of channels and/or groups to which user with specified `auth` key doesn't have access.
`PNMalformedResponseCategory`	Request received in response non-JSON data. It can be because of publish WiFi hotspot which require authorization or proxy server message.
`PNBadRequestCategory`	Request can't be completed because not all required values has been passed or passed values has unexpected data type.
`PNDecryptionErrorCategory`	Message Persistence API may return this status if some messages can't be decrypted. The unencrypted message is returned in `status.associatedObject` (`PNMessageData`), which contains channel and message properties.
`PNTimeoutCategory`	Used API didn't receive a response from the server in time.
`PNUnknownCategory`	No specific category was assigned to the request.
`PNUnexpectedDisconnectCategory`	The SDK can't reach PubNub servers due to connectivity issues (for example, device offline, ISP problems, or proxy).
`PNCancelledCategory`	Request was cancelled by user.
`PNUnknownCategory`	Unknown error happened.

UserId

These functions are used to set/get a user ID on the fly.

Property(s)

To set/get UserId you can use the following property(s) in PHP SDK:

Set UserId

$pnconf->setUserId(string);

* required

Parameter	Description
`UserId` * Type: String Default: n/a	`UserId` to be used as a device identifier. If you don't set the `UserId`, you won't be able to connect to PubNub.

Get UserId

$pnconf->getUserId();

This method doesn't take any arguments.

Sample code

Set UserId

Required User ID

$pnconf = new PNConfiguration();
$pnconf->setUserId("myUniqueUserId");

Get UserId

$pubnub->getConfiguration()
    ->getUserId();

Authentication key

Setter and getter for users auth key.

Set auth key

$pnconf->setAuthKey(string);

* required

Parameter	Description
`AuthKey` * Type: String	If Access Manager is utilized, client will use this `authkey` in all restricted requests.

Get auth key

$pnconf->getAuthKey();

This method doesn't take any argument.

Sample code

Set auth key

$pubnub->getConfiguration()
    ->setAuthKey("my_newauthkey");

Get auth key

$pubnub->getConfiguration()
    ->getAuthKey();

Returns

None.

Filter expression

Requires Stream Controller add-on

This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Stream filtering allows a subscriber to apply a filter to only receive messages that satisfy the conditions of the filter. The message filter is set by the subscribing client(s) but it is applied on the server side thus preventing unwanted messages (those that do not meet the conditions of the filter) from reaching the subscriber.

To set or get message filters, you can use the following methods. To learn more about filtering, refer to the Publish Messages documentation.

Method(s)

Set filter expression

setFilterExpression( string filterExpression )

* required

Parameter	Description
`filterExpression` * Type: string	Logical expression to be evaluated on PubNub servers

Get filter expression

getFilterExpression

This method doesn't take any arguments.

Sample code

Set filter expression

Required User ID

use PubNub\PNConfiguration;
use PubNub\PubNub;

$pnconf = new PNConfiguration();

$pnconf->setSubscribeKey("my_sub_key");
$pnconf->setFilterExpression("userid == 'my_userid'");

$pubnub = new PubNub($pnconf);

Get filter expression

$pubnub->getFilterConfiguration();

Configuration​

Immutable configuration

Method(s)​

Disabling random initialization vector

crypto module​

Legacy encryption with 128-bit cipher key entropy

Sample code​

Required User ID

Reference code

Rest response from server​

Initialization​

Use PHP SDK in your code​

Description​

Method(s)​

Sample code​

Initialize the PubNub client API​

Required User ID

Returns​

Other examples​

Initialize a non-secure client​

Required User ID

Initialization for a Read-Only client​

Required User ID

Use a custom UUID​

Required User ID

Initializing with Access Manager​

Requires Access Manager add-on

Secure your secretKey

Required User ID

Event listeners​

Add listeners​

Remove listeners​

Listener status events​

UserId​

Property(s)​

Set UserId​

Get UserId​

Sample code​

Set UserId​

Required User ID

Get UserId​

Authentication key​

Set auth key​

Get auth key​

Sample code​

Set auth key​

Get auth key​

Returns​

Filter expression​

Requires Stream Controller add-on

Method(s)​

Set filter expression​

Get filter expression​

Sample code​

Set filter expression​

Required User ID

Get filter expression​

Configuration

Method(s)

`crypto` module

Sample code

Rest response from server

Initialization

Use PHP SDK in your code

Description

Method(s)

Sample code

Initialize the PubNub client API

Returns

Other examples

Initialize a non-secure client

Initialization for a Read-Only client

Use a custom UUID

Initializing with Access Manager

Event listeners

Add listeners

Remove listeners

Listener status events

UserId

Property(s)

Set UserId

Get UserId

Sample code

Set UserId

Get UserId

Authentication key

Set auth key

Get auth key

Sample code

Set auth key

Get auth key

Returns

Filter expression

Method(s)

Set filter expression

Get filter expression

Sample code

Set filter expression

Get filter expression