Renamed base64encode and decode util helpers to camelCase, added return types for all helper methods

Author: sacOO7

src/Utils.php

@@ -11,11 +11,11 @@ class Utils
      * @param  string  $jwt
      * @return array
      */
-    public static function parseJwt($jwt)
+    public static function parseJwt($jwt): array
     {
         $tokenParts = explode('.', $jwt);
-        $header = json_decode(self::base64url_decode($tokenParts[0]), true);
-        $payload = json_decode(self::base64url_decode($tokenParts[1]), true);
+        $header = json_decode(self::base64urlDecode($tokenParts[0]), true);
+        $payload = json_decode(self::base64urlDecode($tokenParts[1]), true);
 
         return ['header' => $header, 'payload' => $payload];
     }
@@ -25,13 +25,13 @@ public static function parseJwt($jwt)
      * @param  array  $payload
      * @return string
      */
-    public static function generateJwt($headers, $payload, $key)
+    public static function generateJwt($headers, $payload, $key): string
     {
-        $encodedHeaders = self::base64url_encode(json_encode($headers));
-        $encodedPayload = self::base64url_encode(json_encode($payload));
+        $encodedHeaders = self::base64urlEncode(json_encode($headers));
+        $encodedPayload = self::base64urlEncode(json_encode($payload));
 
         $signature = hash_hmac('SHA256', "$encodedHeaders.$encodedPayload", $key, true);
-        $encodedSignature = self::base64url_encode($signature);
+        $encodedSignature = self::base64urlEncode($signature);
 
         return "$encodedHeaders.$encodedPayload.$encodedSignature";
     }
@@ -41,7 +41,7 @@ public static function generateJwt($headers, $payload, $key)
      * @param  mixed  $timeFn
      * @return bool
      */
-    public static function isJwtValid($jwt, $timeFn, $key)
+    public static function isJwtValid($jwt, $timeFn, $key): bool
     {
         // split the jwt
         $tokenParts = explode('.', $jwt);
@@ -50,28 +50,29 @@ public static function isJwtValid($jwt, $timeFn, $key)
         $tokenSignature = $tokenParts[2];
 
         // check the expiration time - note this will cause an error if there is no 'exp' claim in the jwt
-        $expiration = json_decode(self::base64url_decode($payload))->exp;
+        $expiration = json_decode(self::base64urlDecode($payload))->exp;
         $isTokenExpired = $expiration <= $timeFn();
 
         // build a signature based on the header and payload using the secret
         $signature = hash_hmac('SHA256', $header.'.'.$payload, $key, true);
-        $isSignatureValid = self::base64url_encode($signature) === $tokenSignature;
+        $isSignatureValid = self::base64urlEncode($signature) === $tokenSignature;
 
         return $isSignatureValid && ! $isTokenExpired;
     }
 
     /**
      * https://www.php.net/manual/en/function.base64-encode.php#127544
      */
-    public static function base64url_encode($str): string
+    public static function base64urlEncode($str): string
     {
         return rtrim(strtr(base64_encode($str), '+/', '-_'), '=');
     }
 
     /**
      * https://www.php.net/manual/en/function.base64-encode.php#127544
      */
-    public static function base64url_decode($data) {
+    public static function base64urlDecode($data): string
+    {
         return base64_decode(strtr($data, '-_', '+/'), true);
     }
 
@@ -86,7 +87,7 @@ public static function decodeSocketId($socketId): ?object
     {
         $socketIdObject = null;
         if ($socketId) {
-            $socketIdJsonString = self::base64url_decode($socketId);
+            $socketIdJsonString = self::base64urlDecode($socketId);
             if (!$socketIdJsonString) {
                 throw new AblyException("Base64 decoding failed, ".self::SOCKET_ID_ERROR);
             }

tests/AblyBroadcasterTest.php

@@ -333,7 +333,7 @@ public function testPublishPayloadShouldNotIncludeSocketKey()
         $socketIdObject->clientId = 'sacOO7';
         $payload = [
             'foo' => 'bar',
-            'socket' => Utils::base64url_encode(json_encode($socketIdObject))
+            'socket' => Utils::base64urlEncode(json_encode($socketIdObject))
         ];
 
         $broadcaster->broadcast(["channel1", "channel2"], 'testEvent', $payload);

tests/UtilsTest.php

@@ -38,14 +38,14 @@ public function testDecodeSocketId() {
         $originalSocketIdObj = new \stdClass();
         $originalSocketIdObj->connectionKey = 'key';
         $originalSocketIdObj->clientId = null;
-        $socketIdObject = Utils::decodeSocketId(Utils::base64url_encode(json_encode($originalSocketIdObj)));
+        $socketIdObject = Utils::decodeSocketId(Utils::base64urlEncode(json_encode($originalSocketIdObj)));
         self::assertEquals('key', $socketIdObject->connectionKey);
         self::assertNull($socketIdObject->clientId);
 
         $originalSocketIdObj = new \stdClass();
         $originalSocketIdObj->connectionKey = 'key';
         $originalSocketIdObj->clientId = 'id';
-        $socketIdObject = Utils::decodeSocketId(Utils::base64url_encode(json_encode($originalSocketIdObj)));
+        $socketIdObject = Utils::decodeSocketId(Utils::base64urlEncode(json_encode($originalSocketIdObj)));
         self::assertEquals('key', $socketIdObject->connectionKey);
         self::assertEquals('id', $socketIdObject->clientId);
     }
@@ -64,7 +64,7 @@ public function testExceptionOnMissingClientIdInSocketId()
 
         self::expectException(AblyException::class);
         self::expectExceptionMessage("ClientId is missing, ".Utils::SOCKET_ID_ERROR);
-        Utils::decodeSocketId(Utils::base64url_encode(json_encode($socketIdObject)));
+        Utils::decodeSocketId(Utils::base64urlEncode(json_encode($socketIdObject)));
     }
 
     public function testExceptionOnMissingConnectionKeyInSocketId()
@@ -74,6 +74,6 @@ public function testExceptionOnMissingConnectionKeyInSocketId()
 
         self::expectException(AblyException::class);
         self::expectExceptionMessage("ConnectionKey is not set, ".Utils::SOCKET_ID_ERROR);
-        Utils::decodeSocketId(Utils::base64url_encode(json_encode($socketIdObject)));
+        Utils::decodeSocketId(Utils::base64urlEncode(json_encode($socketIdObject)));
     }
 }