Deprecate Group::listing()

Author: Art4

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/kbsali/php-redmine-api/compare/v2.6.0...v2.x)
 
+### Added
+
+- New method `Redmine\Api\Group::listNames()` for listing the ids and names of all groups.
+
+### Deprecated
+
+- `Redmine\Api\Group::listing()` is deprecated, use `\Redmine\Api\Group::listNames()` instead.
+
 ## [v2.6.0](https://github.com/kbsali/php-redmine-api/compare/v2.5.0...v2.6.0) - 2024-03-25
 
 ### Added

src/Redmine/Api/Group.php

@@ -101,12 +101,17 @@ public function all(array $params = [])
     /**
      * Returns an array of groups with name/id pairs.
      *
+     * @deprecated v2.7.0 Use listNames() instead.
+     * @see Group::listNames()
+     *
      * @param bool $forceUpdate to force the update of the groups var
      *
      * @return array list of groups (id => name)
      */
     public function listing($forceUpdate = false)
     {
+        @trigger_error('`' . __METHOD__ . '()` is deprecated since v2.7.0, use `' . __CLASS__ . '::listNames()` instead.', E_USER_DEPRECATED);
+
         if (empty($this->groups) || $forceUpdate) {
             $this->groups = $this->list();
         }

tests/Unit/Api/GroupTest.php

@@ -113,6 +113,38 @@ public function testAllReturnsClientGetResponseWithParameters()
         $this->assertSame($expectedReturn, $api->all($parameters));
     }
 
+    /**
+     * Test listing().
+     */
+    public function testListingTriggersDeprecationWarning()
+    {
+        $client = $this->createMock(Client::class);
+        $client->method('requestGet')
+            ->willReturn(true);
+        $client->method('getLastResponseBody')
+            ->willReturn('{"groups":[{"id":1,"name":"Group 1"},{"id":5,"name":"Group 5"}]}');
+        $client->method('getLastResponseContentType')
+            ->willReturn('application/json');
+
+        $api = new Group($client);
+
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    '`Redmine\Api\Group::listing()` is deprecated since v2.7.0, use `Redmine\Api\Group::listNames()` instead.',
+                    $errstr
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED
+        );
+
+        $api->listing();
+    }
+
     /**
      * Test listing().
      */