Support for file operations

.pubnub.yml

@@ -1,8 +1,13 @@
 name: php
-version: 6.2.1
+version: 6.3.0
 schema: 1
 scm: github.com/pubnub/php
 changelog:
+  - date: 2024-06-18
+    version: v6.3.0
+    changes:
+      - type: feature
+        text: "Added support for file sharing operations."
   - date: 2024-06-11
     version: v6.2.1
     changes:
@@ -417,8 +422,8 @@ sdks:
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: php-6.2.1.zip
-            location: https://github.com/pubnub/php/releases/tag/v6.2.1
+            package-name: php-6.3.0.zip
+            location: https://github.com/pubnub/php/releases/tag/v6.3.0
             requires:
               - name: rmccue/requests
                 min-version: 1.0.0

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.3.0
+June 18 2024
+
+#### Added
+- Added support for file sharing operations.
+
 ## v6.2.1
 June 11 2024
 

README.md

@@ -41,7 +41,7 @@ You will need the publish and subscribe keys to authenticate your app. Get your
          {
              "require": {
                  <!-- include the latest version from the badge at the top -->
-                 "pubnub/pubnub": "6.2.1"
+                 "pubnub/pubnub": "6.3.0"
              }
          }
          ```

composer.json

@@ -5,7 +5,7 @@
   "keywords": ["api", "real-time", "realtime", "real time", "ajax", "push"],
   "homepage": "http://www.pubnub.com/",
   "license": "proprietary",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "authors": [
     {
       "name": "PubNub",

examples/FileSharing.php

@@ -0,0 +1,73 @@
+<?php
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+use PubNub\PubNub;
+use PubNub\PNConfiguration;
+
+$channelName = "file-channel";
+$fileName = "pn.gif";
+
+$config = new PNConfiguration();
+$config->setSubscribeKey(getenv('SUBSCRIBE_KEY', 'demo'));
+$config->setPublishKey(getenv('PUBLISH_KEY', 'demo'));
+$config->setUserId('example');
+
+$pubnub = new PubNub($config);
+
+// Sending file
+$fileHandle = fopen(__DIR__ . DIRECTORY_SEPARATOR . $fileName, "r");
+$sendFileResult = $pubnub->sendFile()
+    ->channel($channelName)
+    ->fileName($fileName)
+    ->message("Hello from PHP SDK")
+    ->fileHandle($fileHandle)
+    ->sync();
+
+fclose($fileHandle);
+
+// Listing files in the channel
+$channelFiles = $pubnub->listFiles()->channel($channelName)->sync();
+$fileCount = $channelFiles->getCount();
+if ($fileCount > 0) {
+    print("There are {$fileCount} files in the channel {$channelName}\n");
+    foreach ($channelFiles->getFiles() as $idx => $file) {
+        print("File[{$idx}]: {$file->getName()} with ID: {$file->getId()},"
+            . "size {$file->getSize()}, created at: {$file->getCreationTime()}\n");
+    }
+} else {
+    print("There are no files in the channel {$channelName}\n");
+}
+
+$file = $channelFiles->getFiles()[0];
+
+print('Getting download URL for the file...');
+$downloadUrl = $pubnub->getFileDownloadUrl()
+    ->channel($channelName)
+    ->fileId($file->getId())
+    ->fileName($file->getName())
+    ->sync();
+
+printf("To download the file use the following URL: %s\n", $downloadUrl->getFileUrl());
+
+print("Downloading file...");
+$downloadFile = $pubnub->downloadFile()
+    ->channel($channelName)
+    ->fileId($file->getId())
+    ->fileName($file->getName())
+    ->sync();
+file_put_contents(__DIR__ . DIRECTORY_SEPARATOR . $file->getName(), $downloadFile->getFileContent());
+print("done. File saved as: {$file->getName()}\n");
+
+// deleting file
+$deleteFile = $pubnub->deleteFile()
+    ->channel($channelName)
+    ->fileId($file->getId())
+    ->fileName($file->getName())
+    ->sync();
+
+if ($deleteFile->getStatus() === 200) {
+    print("File deleted successfully\n");
+} else {
+    print("Failed to delete file\n");
+}

src/PubNub/Endpoints/Access/Audit.php

@@ -94,12 +94,12 @@ public function sync()
     }
 
     /**
-     * @param array $json Decoded json
+     * @param array $result Decoded json
      * @return PNAccessManagerAuditResult
      */
-    protected function createResponse($json)
+    protected function createResponse($result)
     {
-        return PNAccessManagerAuditResult::fromJson($json['payload']);
+        return PNAccessManagerAuditResult::fromJson($result['payload']);
     }
 
     /**

src/PubNub/Endpoints/Access/Grant.php

@@ -285,12 +285,12 @@ public function sync()
     }
 
     /**
-     * @param array $json
+     * @param array $result
      * @return PNAccessManagerGrantResult
      */
-    public function createResponse($json)
+    public function createResponse($result)
     {
-        return PNAccessManagerGrantResult::fromJson($json['payload']);
+        return PNAccessManagerGrantResult::fromJson($result['payload']);
     }
 
     /**

src/PubNub/Endpoints/ChannelGroups/AddChannelToChannelGroup.php

@@ -79,10 +79,10 @@ protected function buildPath()
     }
 
     /**
-     * @param array $json Decoded json
+     * @param array $result Decoded json
      * @return PNChannelGroupsAddChannelResult
      */
-    protected function createResponse($json)
+    protected function createResponse($result)
     {
         return new PNChannelGroupsAddChannelResult();
     }

src/PubNub/Endpoints/ChannelGroups/ListChannelsInChannelGroup.php

@@ -78,12 +78,12 @@ public function sync()
     }
 
     /**
-     * @param array $json Decoded json
+     * @param array $result Decoded json
      * @return PNChannelGroupsListChannelsResult
      */
-    protected function createResponse($json)
+    protected function createResponse($result)
     {
-        return PNChannelGroupsListChannelsResult::fromPayload(static::fetchPayload($json));
+        return PNChannelGroupsListChannelsResult::fromPayload(static::fetchPayload($result));
     }
 
     /**

src/PubNub/Endpoints/ChannelGroups/RemoveChannelFromChannelGroup.php

@@ -99,10 +99,10 @@ public function sync()
     }
 
     /**
-     * @param array $json Decoded json
+     * @param array $result Decoded json
      * @return PNChannelGroupsRemoveChannelResult
      */
-    protected function createResponse($json)
+    protected function createResponse($result)
     {
         return new PNChannelGroupsRemoveChannelResult();
     }

src/PubNub/Endpoints/ChannelGroups/RemoveChannelGroup.php

@@ -78,10 +78,10 @@ public function sync()
     }
 
     /**
-     * @param array $json Decoded json
+     * @param array $result Decoded json
      * @return PNChannelGroupsRemoveGroupResult
      */
-    protected function createResponse($json)
+    protected function createResponse($result)
     {
         return new PNChannelGroupsRemoveGroupResult();
     }

src/PubNub/Endpoints/Endpoint.php

@@ -25,15 +25,21 @@
 
 abstract class Endpoint
 {
+    protected const RESPONSE_IS_JSON = true;
+
     /** @var  PubNub */
     protected $pubnub;
 
     /** @var  PNEnvelope */
     protected $envelope;
 
+    protected $customHost = null;
+
     /** @var array */
     protected static $cachedTransports = [];
 
+    protected $followRedirects = true;
+
     public function __construct(PubNub $pubnubInstance)
     {
         $this->pubnub = $pubnubInstance;
@@ -42,10 +48,10 @@ public function __construct(PubNub $pubnubInstance)
     abstract protected function validateParams();
 
     /**
-     * @param array $json Decoded json
+     * @param array $result Decoded json
      * @return mixed
      */
-    abstract protected function createResponse($json);
+    abstract protected function createResponse($result);
 
     /**
      * @return int
@@ -321,20 +327,18 @@ protected function invokeRequestAndCacheIt()
      */
     protected function requestOptions()
     {
-        $options = [
+        return [
             'timeout' => $this->getRequestTimeout(),
             'connect_timeout' => $this->getConnectTimeout(),
-            'transport' => $this->getDefaultTransport(),
+            'transport' => $this->getTransport(),
             'useragent' => 'PHP/' . PHP_VERSION,
+            'follow_redirects' => $this->followRedirects,
         ];
+    }
 
-        $transport = $this->pubnub->getConfiguration()->getTransport();
-
-        if ($transport) {
-            $options['transport'] = $transport;
-        }
-
-        return $options;
+    protected function getTransport()
+    {
+        return $this->pubnub->getConfiguration()->getTransport() ?? $this->getDefaultTransport();
     }
 
     /**
@@ -345,7 +349,7 @@ protected function invokeRequest()
         $headers = array_merge($this->defaultHeaders(), $this->customHeaders());
 
         $url = PubNubUtil::buildUrl(
-            $this->pubnub->getBasePath(),
+            $this->pubnub->getBasePath($this->customHost),
             $this->buildPath(),
             $this->buildParams()
         );
@@ -459,28 +463,40 @@ protected function invokeRequest()
                 ['method' => $this->getName(), 'statusCode' => $request->status_code]
             );
 
-            // NOTICE: 1 == JSON_OBJECT_AS_ARRAY (hhvm doesn't support this constant)
-            $parsedJSON = json_decode($request->body, true, 512, 1);
-            $errorMessage = json_last_error_msg();
-
-            if (json_last_error()) {
-                $this->pubnub->getLogger()->error(
-                    "Unable to decode JSON body: " . $request->body,
-                    ['method' => $this->getName()]
+            if (static::RESPONSE_IS_JSON) {
+                // NOTICE: 1 == JSON_OBJECT_AS_ARRAY (hhvm doesn't support this constant)
+                $parsedJSON = json_decode($request->body, true, 512, 1);
+                $errorMessage = json_last_error_msg();
+
+                if (json_last_error()) {
+                    $this->pubnub->getLogger()->error(
+                        "Unable to decode JSON body: " . $request->body,
+                        ['method' => $this->getName()]
+                    );
+
+                    return new PNEnvelope(null, $this->createStatus(
+                        $statusCategory,
+                        $request->body,
+                        $responseInfo,
+                        (new PubNubResponseParsingException())
+                            ->setResponseString($request->body)
+                            ->setDescription($errorMessage)
+                    ));
+                }
+
+                return new PNEnvelope(
+                    $this->createResponse($parsedJSON),
+                    $this->createStatus($statusCategory, $request->body, $responseInfo, null)
+                );
+            } else {
+                return new PNEnvelope(
+                    $this->createResponse($request->body),
+                    $this->createStatus($statusCategory, $request->body, $responseInfo, null)
                 );
-
-                return new PNEnvelope(null, $this->createStatus(
-                    $statusCategory,
-                    $request->body,
-                    $responseInfo,
-                    (new PubNubResponseParsingException())
-                        ->setResponseString($request->body)
-                        ->setDescription($errorMessage)
-                ));
             }
-
+        } elseif ($request->status_code === 307 && !$this->followRedirects) {
             return new PNEnvelope(
-                $this->createResponse($parsedJSON),
+                $this->createResponse($request),
                 $this->createStatus($statusCategory, $request->body, $responseInfo, null)
             );
         } else {
@@ -572,7 +588,7 @@ protected function getAffectedUsers()
      */
     private function getDefaultTransport()
     {
-        $need_ssl = (0 === stripos($this->pubnub->getBasePath(), 'https://'));
+        $need_ssl = (0 === stripos($this->pubnub->getBasePath($this->customHost), 'https://'));
         $capabilities = array('ssl' => $need_ssl);
 
         $cap_string = serialize($capabilities);