PHP 8.0.0 Migration Guide

With the latest update, the PHP SDK has undergone significant changes to improve compatibility and performance. The obsolete transport layer has been replaced with a new implementation that adheres to the PHP Standards Recommendation (PSR). By default, the SDK now uses Guzzle HTTP client.

What has changed

See all the major differences between the two versions:

Feature	PHP SDK v7.X.X	PHP SDK v8.X.X
Method to set transport layer	PubNub::setTransport()	PubNub::setClient()

Transport was removed

The PubNub::setTransport() method has been removed and replaced with PubNub::setClient().

Required changes

If you haven't made any modifications to the default transport layer, this change is seamless and unnoticeable in your application.

If you have, your client should be an instance implementing PSR-18, and optionally, an extended method send accepting additional parameter for custom clients request options, valid for this single call.

use Psr\Http\Client\ClientInterface;

class CustomClient implements ClientInterface
{
    /**
     * Sends a PSR-7 request and returns a PSR-7 response.
     *
     * @param RequestInterface $request
     *
     * @return ResponseInterface
     *
     * @throws \Psr\Http\Client\ClientExceptionInterface If an error happens while processing the request.
     */
    public function sendRequest(RequestInterface $request): ResponseInterface { }

show all 25 lines

Use default HTTP client

If you don't need custom transport layer, you can use the default implementation that uses the GuzzleHttp library as the HTTP client.

This default setup ensures that your application will work seamlessly with the new transport layer, without additional configuration. This setup is sufficient for most use cases and provides a reliable and efficient HTTP client for your application.

use PubNub\PubNub;
use PubNub\PNConfiguration;

$config = new PNConfiguration();
$config->setPublishKey('demo');
$config->setSubscribeKey('demo');
$config->setUserId('demo');
$pubnub = new PubNub();
$pubnub->publish()->channel('test')->message('Hello')->sync();

Use custom HTTP client

If you decide to use a custom HTTP client, your implementation must adhere to PSR-18 ClientInterface. Below is a basic example for the implementation using a built-in cURL method.

class CustomClient implements ClientInterface
{
    public function sendRequest(RequestInterface $request): ResponseInterface
    {
        $ch = curl_init();

        curl_setopt($ch, CURLOPT_URL, (string) $request->getUri());
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $request->getMethod());
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        $headers = [];
        foreach ($request->getHeaders() as $name => $values) {
            foreach ($values as $value) {
                $headers[] = $name . ': ' . $value;
            }

show all 34 lines

This class uses built-in curl to make the request. It also utilizes a support structure for Response which is the ResponseInterface implementation and Stream implementing StreamInterface

To use this sample Client with PubNub SDK instance you have to instantiate it and call PubNub::setClient.

use PubNub\PubNub;
use PubNub\PNConfiguration;
use CustomClient;

$config = new PNConfiguration();
$config->setPublishKey("demo");
$config->setSubscribeKey("demo");
$config->setUserId("test");

$client = new CustomClient();

$pubnub = new PubNub($config);
$pubnub->setClient($client);
$pubnub->publish()->channel('test')->message('Hello')->sync();

Response

Below is a basic implementation of the Response class:

use Psr\Http\Message\ResponseInterface;

class Response implements ResponseInterface
{
    private int $statusCode;
    private array $headers;
    private StreamInterface $body;

    public function __construct(int $statusCode, array $headers, string $body)
    {
        $this->statusCode = $statusCode;
        $this->headers = $headers;
        $this->body = new Stream($body);
    }

show all 90 lines

Stream

Below is a basic implementation of the Stream class:

use Psr\Http\Message\StreamInterface;

class Stream implements StreamInterface
{
    private $stream;
    private $size;

    public function __construct(string $content = '')
    {
        $this->stream = fopen('php://temp', 'r+');
        fwrite($this->stream, $content);
        rewind($this->stream);
        $this->size = strlen($content);
    }

show all 98 lines