chore: fix php 8.4 deprecation warning

Author: tiwarishubham635

.github/workflows/test-and-deploy.yml

@@ -17,7 +17,7 @@ jobs:
     timeout-minutes: 20
     strategy:
       matrix:
-        php: [ '7.3', '7.4', '8.0', '8.1' ]
+        php: [ '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
         dependencies:
           - "lowest"
           - "highest"

CONTRIBUTING.md

@@ -18,7 +18,7 @@ We welcome direct contributions to the php-http-client code base. Thank you!
 
 ##### Prerequisites #####
 
-- PHP version 7.3, 7.4, 8.0, or 8.1
+- PHP version 7.3+
 - [Composer](https://getcomposer.org/)
 
 ##### Initial setup: #####

README.md

@@ -28,7 +28,7 @@ All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
 
 ## Prerequisites
 
-- PHP version 7.3, 7.4, 8.0, or 8.1
+- PHP version 7.3+
 
 ## Install with Composer
 

lib/Client.php

@@ -217,22 +217,22 @@ class Client
     /**
      * Initialize the client.
      *
-     * @param string $host           the base url (e.g. https://api.sendgrid.com)
-     * @param array  $headers        global request headers
-     * @param string $version        api version (configurable) - this is specific to the SendGrid API
-     * @param array  $path           holds the segments of the url path
-     * @param array  $curlOptions    extra options to set during curl initialization
-     * @param bool   $retryOnLimit   set default retry on limit flag
-     * @param bool   $verifySSLCerts set default verify certificates flag
+     * @param string $host the base url (e.g. https://api.sendgrid.com)
+     * @param array|null $headers global request headers
+     * @param string|null $version api version (configurable) - this is specific to the SendGrid API
+     * @param array|null $path holds the segments of the url path
+     * @param array|null $curlOptions extra options to set during curl initialization
+     * @param bool $retryOnLimit set default retry on limit flag
+     * @param bool $verifySSLCerts set default verify certificates flag
      */
     public function __construct(
         $host,
-        $headers = null,
-        $version = null,
-        $path = null,
-        $curlOptions = null,
-        $retryOnLimit = false,
-        $verifySSLCerts = true
+        ?array $headers = null,
+        ?string $version = null,
+        ?array $path = null,
+        ?array $curlOptions = null,
+        bool $retryOnLimit = false,
+        bool $verifySSLCerts = true
     ) {
         $this->host = $host;
         $this->headers = $headers ?: [];
@@ -263,7 +263,7 @@ public function getHost()
     public function setHost(string $host)
     {
         $this->host = $host;
-        
+
         return $this;
     }
 
@@ -358,13 +358,13 @@ public function setIsConcurrentRequest($isConcurrent)
     /**
      * Build the final URL to be passed.
      *
-     * @param array $queryParams an array of all the query parameters
+     * @param array|null $queryParams an array of all the query parameters
      *
      * Nested arrays will resolve to multiple instances of the same parameter
      *
      * @return string
      */
-    private function buildUrl($queryParams = null)
+    private function buildUrl(?array $queryParams = null)
     {
         $path = '/' . implode('/', $this->path);
         if (isset($queryParams)) {
@@ -380,12 +380,12 @@ private function buildUrl($queryParams = null)
      * this function does not mutate any private variables.
      *
      * @param string $method
-     * @param array  $body
-     * @param array  $headers
+     * @param array|null $body
+     * @param array|null $headers
      *
      * @return array
      */
-    private function createCurlOptions($method, $body = null, $headers = null)
+    private function createCurlOptions($method, ?array $body = null, ?array $headers = null)
     {
         $options = [
                 CURLOPT_RETURNTRANSFER => true,
@@ -498,17 +498,17 @@ private function retryRequest(array $responseHeaders, $method, $url, $body, $hea
      * Make the API call and return the response.
      * This is separated into it's own function, so we can mock it easily for testing.
      *
-     * @param string $method       the HTTP verb
-     * @param string $url          the final url to call
-     * @param array  $body         request body
-     * @param array  $headers      any additional request headers
-     * @param bool   $retryOnLimit should retry if rate limit is reach?
+     * @param string $method the HTTP verb
+     * @param string $url the final url to call
+     * @param array|null $body request body
+     * @param array|null $headers any additional request headers
+     * @param bool $retryOnLimit should retry if rate limit is reach?
      *
      * @return Response object
      *
      * @throws InvalidRequest
      */
-    public function makeRequest($method, $url, $body = null, $headers = null, $retryOnLimit = false)
+    public function makeRequest($method, $url, ?array $body = null, ?array $headers = null, $retryOnLimit = false)
     {
         $channel = curl_init($url);
 
@@ -604,7 +604,7 @@ public function makeAllRequests(array $requests = [])
      *
      * @return Client object
      */
-    public function _($name = null)
+    public function _(?string $name = null)
     {
         if (isset($name)) {
             $this->path[] = $name;

lib/Exception/InvalidRequest.php

@@ -12,7 +12,7 @@ class InvalidRequest extends \Exception
     public function __construct(
         $message = '',
         $code = 0,
-        \Exception $previous = null
+        ?\Exception $previous = null
     ) {
         $message = 'Could not send request to server. ' .
             'CURL error ' . $code . ': ' . $message;

test/unit/MockClient.php

@@ -10,7 +10,7 @@ class MockClient extends Client
     public $requestHeaders;
     public $url;
 
-    public function makeRequest($method, $url, $requestBody = null, $requestHeaders = null, $retryOnLimit = false)
+    public function makeRequest($method, $url, ?array $requestBody = null, ?array $requestHeaders = null, $retryOnLimit = false)
     {
         $this->requestBody = $requestBody;
         $this->requestHeaders = $requestHeaders;