Add method Group::listNames()

Author: Art4

src/Redmine/Api/Group.php

@@ -43,6 +43,26 @@ final public function list(array $params = []): array
         }
     }
 
+    /**
+     * Returns an array of all groups with id/name pairs.
+     *
+     * @return array<int,string> list of groups (id => name)
+     */
+    final public function listNames(): array
+    {
+        if (empty($this->groups)) {
+            $this->groups = $this->list();
+        }
+
+        $list = [];
+
+        foreach ($this->groups['groups'] as $e) {
+            $list[(int) $e['id']] = $e['name'];
+        }
+
+        return $list;
+    }
+
     /**
      * List groups.
      *

tests/Unit/Api/Group/ListNamesTest.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Redmine\Tests\Unit\Api\Group;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\Group;
+use Redmine\Exception\MissingParameterException;
+use Redmine\Http\HttpClient;
+use Redmine\Tests\Fixtures\AssertingHttpClient;
+use SimpleXMLElement;
+
+#[CoversClass(Group::class)]
+class ListNamesTest extends TestCase
+{
+    /**
+     * @dataProvider getListNamesData
+     */
+    #[DataProvider('getListNamesData')]
+    public function testListNamesReturnsCorrectResponse($expectedPath, $responseCode, $response, $expectedResponse)
+    {
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                $expectedPath,
+                'application/json',
+                '',
+                $responseCode,
+                'application/json',
+                $response,
+            ]
+        );
+
+        // Create the object under test
+        $api = new Group($client);
+
+        // Perform the tests
+        $this->assertSame($expectedResponse, $api->listNames());
+    }
+
+    public static function getListNamesData(): array
+    {
+        return [
+            'test with minimal parameters' => [
+                '/groups.json',
+                201,
+                <<<JSON
+                {
+                    "groups": [
+                        {
+                            "id": 1,
+                            "name": "Group 1"
+                        }
+                    ]
+                }
+                JSON,
+                [
+                    1 => "Group 1",
+                ]
+            ],
+        ];
+    }
+}