Deprecate Version::listing()

Author: Art4

CHANGELOG.md

@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Redmine\Api\Role::listing()` is deprecated, use `\Redmine\Api\Role::listNames()` instead.
 - `Redmine\Api\TimeEntryActivity::listing()` is deprecated, use `\Redmine\Api\TimeEntryActivity::listNames()` instead.
 - `Redmine\Api\Tracker::listing()` is deprecated, use `\Redmine\Api\Tracker::listNames()` instead.
+- `Redmine\Api\Version::listing()` is deprecated, use `\Redmine\Api\Version::listNamesByProject()` instead.
 
 ## [v2.6.0](https://github.com/kbsali/php-redmine-api/compare/v2.5.0...v2.6.0) - 2024-03-25
 

src/Redmine/Api/Version.php

@@ -125,6 +125,9 @@ public function all($project, array $params = [])
     /**
      * Returns an array of name/id pairs (or id/name if not $reverse) of versions for $project.
      *
+     * @deprecated v2.7.0 Use listNamesByProject() instead.
+     * @see Version::listNamesByProject()
+     *
      * @param string|int $project     project id or literal identifier
      * @param bool       $forceUpdate to force the update of the projects var
      * @param bool       $reverse     to return an array indexed by name rather than id
@@ -134,6 +137,8 @@ public function all($project, array $params = [])
      */
     public function listing($project, $forceUpdate = false, $reverse = true, array $params = [])
     {
+        @trigger_error('`' . __METHOD__ . '()` is deprecated since v2.7.0, use `' . __CLASS__ . '::listNamesByProject()` instead.', E_USER_DEPRECATED);
+
         if (true === $forceUpdate || empty($this->versions)) {
             $this->versions = $this->listByProject($project, $params);
         }

tests/Unit/Api/VersionTest.php

@@ -246,6 +246,38 @@ public function testListingCallsGetEveryTimeWithForceUpdate()
         $this->assertSame($expectedReturn, $api->listing(5, true));
     }
 
+    /**
+     * Test listing().
+     */
+    public function testListingTriggersDeprecationWarning()
+    {
+        $client = $this->createMock(Client::class);
+        $client->method('requestGet')
+            ->willReturn(true);
+        $client->method('getLastResponseBody')
+            ->willReturn('{"versions":[{"id":1,"name":"Version 1"},{"id":5,"name":"Version 5"}]}');
+        $client->method('getLastResponseContentType')
+            ->willReturn('application/json');
+
+        $api = new Version($client);
+
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    '`Redmine\Api\Version::listing()` is deprecated since v2.7.0, use `Redmine\Api\Version::listNamesByProject()` instead.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        $api->listing(5);
+    }
+
     /**
      * Test getIdByName().
      */
@@ -282,7 +314,6 @@ public function testGetIdByNameMakesGetRequest()
      *
      * @dataProvider      invalidSharingProvider
      *
-     *
      * @param string $sharingValue
      */
     #[DataProvider('invalidSharingProvider')]