Working on next version

Author: GrahamCampbell

.styleci.yml

@@ -16,7 +16,6 @@ enabled:
 disabled:
   - native_constant_invocation_symfony
   - native_function_invocation_symfony
-  - no_superfluous_phpdoc_tags_symfony
   - phpdoc_align
   - phpdoc_to_comment
   - phpdoc_var_without_name

CHANGELOG.md

@@ -5,9 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [11.15.0] - UPCOMING
+## [12.0.0] - UPCOMING
 
-* TBC
+* Drop support for PHP earlier than 8.1
 
 ## [11.14.0] - 2024-03-11
 

README.md

@@ -28,22 +28,21 @@ This version supports [PHP](https://php.net) 7.4-8.3. To get started, simply req
 ### Standard Installation
 
 ```bash
-$ composer require "m4tthumphrey/php-gitlab-api:^11.15" \
-  "guzzlehttp/guzzle:^7.8" "http-interop/http-factory-guzzle:^1.2"
+$ composer require "m4tthumphrey/php-gitlab-api:^12.0" "guzzlehttp/guzzle:^7.9.2"
 ```
 
 ### Framework Integration
 
 #### Laravel:
 
 ```bash
-$ composer require "graham-campbell/gitlab:^7.6"
+$ composer require "graham-campbell/gitlab:^8.0"
 ```
 
 #### Symfony:
 
 ```bash
-$ composer require "zeichen32/gitlabapibundle:^6.1"
+$ composer require "zeichen32/gitlabapibundle:^7.0"
 ```
 
 We are decoupled from any HTTP messaging client by using [PSR-7](https://www.php-fig.org/psr/psr-7/), [PSR-17](https://www.php-fig.org/psr/psr-17/), [PSR-18](https://www.php-fig.org/psr/psr-18/), and [HTTPlug](https://httplug.io/). You can visit [HTTPlug for library users](https://docs.php-http.org/en/latest/httplug/users.html) to get more information about installing HTTPlug related packages. The framework integration [graham-campbell/gitlab](https://github.com/GrahamCampbell/Laravel-GitLab) is by [Graham Campbell](https://github.com/GrahamCampbell) and [zeichen32/gitlabapibundle](https://github.com/Zeichen32/GitLabApiBundle) is by [Jens Averkamp](https://github.com/Zeichen32).
@@ -96,7 +95,7 @@ $builder->addPlugin($plugin);
 $client = new Gitlab\Client($builder);
 ```
 
-One can read more about HTTPlug plugins [here](https://docs.php-http.org/en/latest/plugins/introduction.html#how-it-works). Take a look around the [API methods](https://github.com/GitLabPHP/Client/tree/11.15/src/Api), and please feel free to report any bugs, noting our [code of conduct](.github/CODE_OF_CONDUCT.md).
+One can read more about HTTPlug plugins [here](https://docs.php-http.org/en/latest/plugins/introduction.html#how-it-works). Take a look around the [API methods](https://github.com/GitLabPHP/Client/tree/12.0/src/Api), and please feel free to report any bugs, noting our [code of conduct](.github/CODE_OF_CONDUCT.md).
 
 
 ## Contributing

composer.json

@@ -26,25 +26,23 @@
         }
     ],
     "require": {
-        "php": "^7.4.15 || ^8.0.2",
+        "php": "^8.1",
         "ext-json": "*",
         "ext-xml": "*",
-        "php-http/cache-plugin": "^1.8.1 || ^2.0",
-        "php-http/client-common": "^2.7.1",
-        "php-http/discovery": "^1.19.2",
-        "php-http/httplug": "^2.4",
-        "php-http/multipart-stream-builder": "^1.3",
-        "psr/cache": "^1.0 || ^2.0 || ^3.0",
+        "php-http/cache-plugin": "^2.0.1",
+        "php-http/client-common": "^2.7.2",
+        "php-http/discovery": "^1.20.0",
+        "php-http/httplug": "^2.4.1",
+        "php-http/multipart-stream-builder": "^1.4.2",
+        "psr/cache": "^2.0 || ^3.0",
         "psr/http-client-implementation": "^1.0",
         "psr/http-factory-implementation": "^1.0",
         "psr/http-message": "^1.1 || ^2.0",
-        "symfony/options-resolver": "^4.4 || ^5.0 || ^6.0 || ^7.0",
-        "symfony/polyfill-php80": "^1.26"
+        "symfony/options-resolver": "^5.4 || ^6.0 || ^7.0"
     },
     "require-dev": {
         "bamarni/composer-bin-plugin": "^1.8.2",
-        "guzzlehttp/guzzle": "^7.8",
-        "http-interop/http-factory-guzzle": "^1.2"
+        "guzzlehttp/guzzle": "^7.9.2"
     },
     "autoload": {
         "psr-4": {

src/Api/AbstractApi.php

@@ -48,30 +48,14 @@ abstract class AbstractApi
      */
     protected const ACCESS_LEVELS = [0, 10, 20, 30, 40, 50];
 
-    /**
-     * The client instance.
-     *
-     * @var Client
-     */
-    private $client;
+    private readonly Client $client;
 
-    /**
-     * The per page parameter.
-     *
-     * @var int|null
-     */
-    private $perPage;
+    private ?int $perPage;
 
-    /**
-     * Create a new API instance.
-     *
-     * @param Client $client
-     *
-     * @return void
-     */
     public function __construct(Client $client)
     {
         $this->client = $client;
+        $this->perPage = null;
     }
 
     /**

src/Api/Groups.php

@@ -91,7 +91,7 @@ public function show($id)
      *
      * @return mixed
      */
-    public function create(string $name, string $path, string $description = null, string $visibility = 'private', bool $lfs_enabled = null, bool $request_access_enabled = null, int $parent_id = null, int $shared_runners_minutes_limit = null)
+    public function create(string $name, string $path, ?string $description = null, string $visibility = 'private', ?bool $lfs_enabled = null, ?bool $request_access_enabled = null, ?int $parent_id = null, ?int $shared_runners_minutes_limit = null)
     {
         $params = [
             'name' => $name,
@@ -917,7 +917,7 @@ private function getSubgroupSearchResolver()
      *
      * @return mixed
      */
-    public function deployTokens($group_id, bool $active = null)
+    public function deployTokens($group_id, ?bool $active = null)
     {
         return $this->get('groups/'.self::encodePath($group_id).'/deploy_tokens', (null !== $active) ? ['active' => $active] : []);
     }

src/Api/Projects.php

@@ -466,7 +466,7 @@ public function pipelineTestReportSummary($project_id, int $pipeline_id)
      *
      * @return mixed
      */
-    public function createPipeline($project_id, string $commit_ref, array $variables = null)
+    public function createPipeline($project_id, string $commit_ref, ?array $variables = null)
     {
         $parameters = [];
 
@@ -588,7 +588,7 @@ public function allMember($project_id, int $user_id)
      *
      * @return mixed
      */
-    public function addMember($project_id, int $user_id, int $access_level, string $expires_at = null)
+    public function addMember($project_id, int $user_id, int $access_level, ?string $expires_at = null)
     {
         $params = [
             'user_id' => $user_id,
@@ -609,7 +609,7 @@ public function addMember($project_id, int $user_id, int $access_level, string $
      *
      * @return mixed
      */
-    public function saveMember($project_id, int $user_id, int $access_level, string $expires_at = null)
+    public function saveMember($project_id, int $user_id, int $access_level, ?string $expires_at = null)
     {
         $params = [
             'access_level' => $access_level,
@@ -868,7 +868,7 @@ public function enableDeployKey($project_id, int $key_id)
      *
      * @return mixed
      */
-    public function deployTokens($project_id, bool $active = null)
+    public function deployTokens($project_id, ?bool $active = null)
     {
         return $this->get($this->getProjectPath($project_id, 'deploy_tokens'), (null !== $active) ? ['active' => $active] : []);
     }

src/Api/Repositories.php

@@ -419,7 +419,7 @@ public function postCommitBuildStatus($project_id, string $sha, string $state, a
      *
      * @return mixed
      */
-    public function compare($project_id, string $fromShaOrMaster, string $toShaOrMaster, bool $straight = false, string $fromProjectId = null)
+    public function compare($project_id, string $fromShaOrMaster, string $toShaOrMaster, bool $straight = false, ?string $fromProjectId = null)
     {
         $params = [
             'from' => $fromShaOrMaster,

src/Client.php

@@ -100,30 +100,12 @@ class Client
      *
      * @var string
      */
-    private const USER_AGENT = 'gitlab-php-api-client/11.15';
+    private const USER_AGENT = 'gitlab-php-api-client/12.0';
 
-    /**
-     * The HTTP client builder.
-     *
-     * @var Builder
-     */
-    private $httpClientBuilder;
-
-    /**
-     * The response history plugin.
-     *
-     * @var History
-     */
-    private $responseHistory;
+    private readonly Builder $httpClientBuilder;
+    private readonly History $responseHistory;
 
-    /**
-     * Instantiate a new Gitlab client.
-     *
-     * @param Builder|null $httpClientBuilder
-     *
-     * @return void
-     */
-    public function __construct(Builder $httpClientBuilder = null)
+    public function __construct(?Builder $httpClientBuilder = null)
     {
         $this->httpClientBuilder = $builder = $httpClientBuilder ?? new Builder();
         $this->responseHistory = new History();
@@ -425,7 +407,7 @@ public function wiki(): Wiki
      *
      * @return void
      */
-    public function authenticate(string $token, string $authMethod, string $sudo = null): void
+    public function authenticate(string $token, string $authMethod, ?string $sudo = null): void
     {
         $this->getHttpClientBuilder()->removePlugin(Authentication::class);
         $this->getHttpClientBuilder()->addPlugin(new Authentication($authMethod, $token, $sudo));

src/HttpClient/Builder.php

@@ -38,77 +38,34 @@
  */
 final class Builder
 {
-    /**
-     * The object that sends HTTP messages.
-     *
-     * @var ClientInterface
-     */
-    private $httpClient;
-
-    /**
-     * The HTTP request factory.
-     *
-     * @var RequestFactoryInterface
-     */
-    private $requestFactory;
-
-    /**
-     * The HTTP stream factory.
-     *
-     * @var StreamFactoryInterface
-     */
-    private $streamFactory;
-
-    /**
-     * The URI factory.
-     *
-     * @var UriFactoryInterface
-     */
-    private $uriFactory;
+    private readonly ClientInterface $httpClient;
+    private readonly RequestFactoryInterface $requestFactory;
+    private readonly StreamFactoryInterface $streamFactory;
+    private readonly UriFactoryInterface $uriFactory;
 
     /**
-     * The currently registered plugins.
-     *
      * @var Plugin[]
      */
-    private $plugins = [];
+    private array $plugins = [];
 
-    /**
-     * The cache plugin to use.
-     *
-     * This plugin is specially treated because it has to be the very last plugin.
-     *
-     * @var CachePlugin|null
-     */
-    private $cachePlugin;
+    private ?CachePlugin $cachePlugin;
 
-    /**
-     * A HTTP client with all our plugins.
-     *
-     * @var HttpMethodsClientInterface|null
-     */
-    private $pluginClient;
+    private ?HttpMethodsClientInterface $pluginClient;
 
-    /**
-     * Create a new http client builder instance.
-     *
-     * @param ClientInterface|null         $httpClient
-     * @param RequestFactoryInterface|null $requestFactory
-     * @param StreamFactoryInterface|null  $streamFactory
-     * @param UriFactoryInterface|null     $uriFactory
-     *
-     * @return void
-     */
     public function __construct(
-        ClientInterface $httpClient = null,
-        RequestFactoryInterface $requestFactory = null,
-        StreamFactoryInterface $streamFactory = null,
-        UriFactoryInterface $uriFactory = null
+        ?ClientInterface $httpClient = null,
+        ?RequestFactoryInterface $requestFactory = null,
+        ?StreamFactoryInterface $streamFactory = null,
+        ?UriFactoryInterface $uriFactory = null
     ) {
         $this->httpClient = $httpClient ?? Psr18ClientDiscovery::find();
         $this->requestFactory = $requestFactory ?? Psr17FactoryDiscovery::findRequestFactory();
         $this->streamFactory = $streamFactory ?? Psr17FactoryDiscovery::findStreamFactory();
         $this->uriFactory = $uriFactory ?? Psr17FactoryDiscovery::findUriFactory();
+
+        $this->plugins = [];
+        $this->cachePlugin = null;
+        $this->pluginClient = null;
     }
 
     /**