Merge branch '9.18' into 9.19

Author: GrahamCampbell

lib/Gitlab/Api/AbstractApi.php

@@ -4,8 +4,8 @@
 
 use Gitlab\Client;
 use Gitlab\Exception\RuntimeException;
-use Gitlab\HttpClient\Message\QueryStringBuilder;
 use Gitlab\HttpClient\Message\ResponseMediator;
+use Gitlab\HttpClient\Util\QueryStringBuilder;
 use Http\Discovery\StreamFactoryDiscovery;
 use Http\Message\MultipartStream\MultipartStreamBuilder;
 use Http\Message\StreamFactory;

lib/Gitlab/HttpClient/Message/QueryStringBuilder.php

@@ -2,6 +2,11 @@
 
 namespace Gitlab\HttpClient\Message;
 
+use Gitlab\HttpClient\Util\QueryStringBuilder as UtilQueryStringBuilder;
+
+/**
+ * @deprecated since 9.18 and will be removed in 10.0.
+ */
 final class QueryStringBuilder
 {
     /**
@@ -11,42 +16,14 @@ final class QueryStringBuilder
      * @param mixed $query
      *
      * @return string
+     *
+     * @deprecated since 9.18 and will be removed in 10.0.
      */
     public static function build($query)
     {
-        if (!is_array($query)) {
-            return self::rawurlencode($query);
-        }
-        $query = array_filter($query, function ($value) {
-            return null !== $value;
-        });
+        @trigger_error(sprintf('The %s() method is deprecated since version 9.18 and will be removed in 10.0.', __METHOD__), E_USER_DEPRECATED);
 
-        return implode('&', array_map(function ($value, $key) {
-            return self::encode($value, $key);
-        }, $query, array_keys($query)));
-    }
-
-    /**
-     * Encode a value.
-     *
-     * @param mixed  $query
-     * @param string $prefix
-     *
-     * @return string
-     */
-    private static function encode($query, $prefix)
-    {
-        if (!is_array($query)) {
-            return self::rawurlencode($prefix).'='.self::rawurlencode($query);
-        }
-
-        $isIndexedArray = self::isIndexedArray($query);
-
-        return implode('&', array_map(function ($value, $key) use ($prefix, $isIndexedArray) {
-            $prefix = $isIndexedArray ? $prefix.'[]' : $prefix.'['.$key.']';
-
-            return self::encode($value, $prefix);
-        }, $query, array_keys($query)));
+        return UtilQueryStringBuilder::build($query);
     }
 
     /**
@@ -55,29 +32,17 @@ private static function encode($query, $prefix)
      * @param array $query
      *
      * @return bool
+     *
+     * @deprecated since 9.18 and will be removed in 10.0.
      */
     public static function isIndexedArray(array $query)
     {
+        @trigger_error(sprintf('The %s() method is deprecated since version 9.18 and will be removed in 10.0.', __METHOD__), E_USER_DEPRECATED);
+
         if (0 === count($query) || !isset($query[0])) {
             return false;
         }
 
         return array_keys($query) === range(0, count($query) - 1);
     }
-
-    /**
-     * Encode a value like rawurlencode, but return "0" when false is given.
-     *
-     * @param mixed $value
-     *
-     * @return string
-     */
-    private static function rawurlencode($value)
-    {
-        if (false === $value) {
-            return '0';
-        }
-
-        return rawurlencode((string) $value);
-    }
 }

lib/Gitlab/HttpClient/Plugin/ApiVersion.php

@@ -10,6 +10,8 @@
 /**
  * Prefix requests path with /api/v4/ if required.
  *
+ * @internal
+ *
  * @final
  *
  * @author Fabien Bourigault <[email protected]>

lib/Gitlab/HttpClient/Plugin/Authentication.php

@@ -10,6 +10,8 @@
 /**
  * Add authentication to the request.
  *
+ * @internal
+ *
  * @final
  *
  * @author Tobias Nyholm <[email protected]>

lib/Gitlab/HttpClient/Plugin/GitlabExceptionThrower.php

@@ -15,6 +15,8 @@
 /**
  * A plugin to remember the last response.
  *
+ * @internal
+ *
  * @final
  *
  * @author Tobias Nyholm <[email protected]>

lib/Gitlab/HttpClient/Plugin/History.php

@@ -9,6 +9,8 @@
 /**
  * A plugin to remember the last response.
  *
+ * @internal
+ *
  * @final
  *
  * @author Tobias Nyholm <[email protected]>

lib/Gitlab/HttpClient/Plugin/HistoryTrait.php

@@ -8,6 +8,9 @@
 use Psr\Http\Message\RequestInterface;
 
 if (interface_exists(HttpMethodsClientInterface::class)) {
+    /**
+     * @internal
+     */
     trait HistoryTrait
     {
         /**
@@ -23,6 +26,9 @@ public function addFailure(RequestInterface $request, ClientExceptionInterface $
         }
     }
 } else {
+    /**
+     * @internal
+     */
     trait HistoryTrait
     {
         /**

lib/Gitlab/HttpClient/Util/QueryStringBuilder.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Gitlab\HttpClient\Util;
+
+/**
+ * @internal
+ */
+final class QueryStringBuilder
+{
+    /**
+     * Encode a query as a query string according to RFC 3986.
+     *
+     * Indexed arrays are encoded using empty squared brackets ([]) unlike
+     * `http_build_query`.
+     *
+     * @param mixed $query
+     *
+     * @return string
+     */
+    public static function build($query)
+    {
+        if (!is_array($query)) {
+            return self::rawurlencode($query);
+        }
+        $query = array_filter($query, function ($value) {
+            return null !== $value;
+        });
+
+        return implode('&', array_map(function ($value, $key) {
+            return self::encode($value, $key);
+        }, $query, array_keys($query)));
+    }
+
+    /**
+     * Encode a value.
+     *
+     * @param mixed  $query
+     * @param string $prefix
+     *
+     * @return string
+     */
+    private static function encode($query, $prefix)
+    {
+        if (!is_array($query)) {
+            return self::rawurlencode($prefix).'='.self::rawurlencode($query);
+        }
+
+        $isList = self::isList($query);
+
+        return implode('&', array_map(function ($value, $key) use ($prefix, $isList) {
+            $prefix = $isList ? $prefix.'[]' : $prefix.'['.$key.']';
+
+            return self::encode($value, $prefix);
+        }, $query, array_keys($query)));
+    }
+
+    /**
+     * Tell if the given array is a list.
+     *
+     * @param array $query
+     *
+     * @return bool
+     */
+    private static function isList(array $query)
+    {
+        if (0 === count($query) || !isset($query[0])) {
+            return false;
+        }
+
+        return array_keys($query) === range(0, count($query) - 1);
+    }
+
+    /**
+     * Encode a value like rawurlencode, but return "0" when false is given.
+     *
+     * @param mixed $value
+     *
+     * @return string
+     */
+    private static function rawurlencode($value)
+    {
+        if (false === $value) {
+            return '0';
+        }
+
+        return rawurlencode((string) $value);
+    }
+}

lib/Gitlab/ResultPager.php

@@ -9,6 +9,8 @@
 /**
  * This is the result pager class.
  *
+ * @final
+ *
  * @author Ramon de la Fuente <[email protected]>
  * @author Mitchel Verschoof <[email protected]>
  * @author Graham Campbell <[email protected]>

phpstan-baseline.neon

@@ -65,3 +65,18 @@ parameters:
 			count: 1
 			path: lib/Gitlab/ResultPager.php
 
+		-
+			message: "#^Method Gitlab\\\\ResultPager\\:\\:postFetch\\(\\) is protected, but since the containing class is final, it can be private\\.$#"
+			count: 1
+			path: lib/Gitlab/ResultPager.php
+
+		-
+			message: "#^Method Gitlab\\\\ResultPager\\:\\:has\\(\\) is protected, but since the containing class is final, it can be private\\.$#"
+			count: 1
+			path: lib/Gitlab/ResultPager.php
+
+		-
+			message: "#^Method Gitlab\\\\ResultPager\\:\\:get\\(\\) is protected, but since the containing class is final, it can be private\\.$#"
+			count: 1
+			path: lib/Gitlab/ResultPager.php
+