feat: create IssueCategory::fromHttpClient()

Art4 · Art4 · commit 67d5c27c6d03 · 2026-01-04T16:06:41.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New method `Redmine\Api\CustomField::fromHttpClient()` for creating the class.
 - New method `Redmine\Api\Group::fromHttpClient()` for creating the class.
 - New method `Redmine\Api\Issue::fromHttpClient()` for creating the class.
+- New method `Redmine\Api\IssueCategory::fromHttpClient()` for creating the class.
 - Add support for PHP 8.5
 - Add support for Redmine 6.1.
 
@@ -30,6 +31,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Extending `Redmine\Api\Group` is deprecated and will be set to final in future, create a wrapper class instead.
 - `Redmine\Api\Issue::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\Issue::fromHttpClient()` instead.
 - Extending `Redmine\Api\Issue` is deprecated and will be set to final in future, create a wrapper class instead.
+- `Redmine\Api\IssueCategory::__construct()` is deprecated and will be set to private in future, use `\Redmine\Api\IssueCategory::fromHttpClient()` instead.
+- Extending `Redmine\Api\IssueCategory` is deprecated and will be set to final in future, create a wrapper class instead.
 
 ### Removed
 
diff --git a/src/Redmine/Api/CustomField.php b/src/Redmine/Api/CustomField.php
@@ -34,7 +34,7 @@ final public static function fromHttpClient(HttpClient $httpClient): self
 
     /**
      * @deprecated v2.9.0 Use fromHttpClient() instead.
-     * @see Issue::fromHttpClient()
+     * @see CustomField::fromHttpClient()
      *
      * @param Client|HttpClient $client
      */
diff --git a/src/Redmine/Api/Group.php b/src/Redmine/Api/Group.php
@@ -40,7 +40,7 @@ final public static function fromHttpClient(HttpClient $httpClient): self
 
     /**
      * @deprecated v2.9.0 Use fromHttpClient() instead.
-     * @see Issue::fromHttpClient()
+     * @see Group::fromHttpClient()
      *
      * @param Client|HttpClient $client
      */
diff --git a/src/Redmine/Api/Issue.php b/src/Redmine/Api/Issue.php
@@ -522,7 +522,7 @@ private function getIssueCategoryApi()
                 /** @var IssueCategory */
                 $issueCategoryApi = $this->client->getApi('issue_category');
             } else {
-                $issueCategoryApi = new IssueCategory($this->getHttpClient());
+                $issueCategoryApi = IssueCategory::fromHttpClient($this->getHttpClient());
             }
 
             $this->issueCategoryApi = $issueCategoryApi;
diff --git a/src/Redmine/Api/IssueCategory.php b/src/Redmine/Api/IssueCategory.php
@@ -2,11 +2,13 @@
 
 namespace Redmine\Api;
 
+use Redmine\Client\Client;
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\MissingParameterException;
 use Redmine\Exception\SerializerException;
 use Redmine\Exception\UnexpectedResponseException;
+use Redmine\Http\HttpClient;
 use Redmine\Http\HttpFactory;
 use Redmine\Serializer\JsonSerializer;
 use Redmine\Serializer\PathSerializer;
@@ -22,6 +24,11 @@
  */
 class IssueCategory extends AbstractApi
 {
+    final public static function fromHttpClient(HttpClient $httpClient): self
+    {
+        return new self($httpClient, true);
+    }
+
     /**
     * @var null|array<mixed>
     */
@@ -32,6 +39,32 @@ class IssueCategory extends AbstractApi
      */
     private array $issueCategoriesNames = [];
 
+    /**
+     * @deprecated v2.9.0 Use fromHttpClient() instead.
+     * @see IssueCategory::fromHttpClient()
+     *
+     * @param Client|HttpClient $client
+     */
+    public function __construct($client/*, bool $privatelyCalled = false*/)
+    {
+        $privatelyCalled = (func_num_args() > 1) ? func_get_arg(1) : false;
+
+        if ($privatelyCalled === true) {
+            parent::__construct($client);
+
+            return;
+        }
+
+        if (static::class !== self::class) {
+            $className = (new \ReflectionClass($this))->isAnonymous() ? '' : ' in `' . static::class . '`';
+            @trigger_error('Class `' . self::class . '` will declared as final in v3.0.0, stop extending it' . $className . '.', E_USER_DEPRECATED);
+        } else {
+            @trigger_error('Method `' . __METHOD__ . '()` is deprecated since v2.9.0 and will declared as private in v3.0.0, use `' . self::class . '::fromHttpClient()` instead.', E_USER_DEPRECATED);
+        }
+
+        parent::__construct($client);
+    }
+
     /**
      * List issue categories for a given project.
      *
diff --git a/tests/Unit/Api/IssueCategory/CreateTest.php b/tests/Unit/Api/IssueCategory/CreateTest.php
@@ -34,7 +34,7 @@ public function testCreateReturnsCorrectResponse($identifier, array $parameters,
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $return = $api->create($identifier, $parameters);
@@ -89,7 +89,7 @@ public function testCreateReturnsEmptyString(): void
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $return = $api->create(5, ['name' => 'Test Category']);
@@ -103,7 +103,7 @@ public function testCreateThrowsExceptionWithEmptyParameters(): void
         $client = $this->createMock(HttpClient::class);
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         $this->expectException(MissingParameterException::class);
         $this->expectExceptionMessage('Theses parameters are mandatory: `name');
@@ -122,7 +122,7 @@ public function testCreateThrowsExceptionIfMandatoyParametersAreMissing(array $p
         $client = $this->createMock(HttpClient::class);
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         $this->expectException(MissingParameterException::class);
         $this->expectExceptionMessage('Theses parameters are mandatory: `name');
diff --git a/tests/Unit/Api/IssueCategory/FromHttpClientTest.php b/tests/Unit/Api/IssueCategory/FromHttpClientTest.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Redmine\Tests\Unit\Api\IssueCategory;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\IssueCategory;
+use Redmine\Http\HttpClient;
+
+#[CoversClass(IssueCategory::class)]
+class FromHttpClientTest extends TestCase
+{
+    public function testReturnsCorrectObject(): void
+    {
+        $httpClient = $this->createStub(HttpClient::class);
+
+        $api = IssueCategory::fromHttpClient($httpClient);
+
+        $this->assertInstanceOf(IssueCategory::class, $api);
+    }
+}
diff --git a/tests/Unit/Api/IssueCategory/ListByProjectTest.php b/tests/Unit/Api/IssueCategory/ListByProjectTest.php
@@ -6,10 +6,10 @@
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use PHPUnit\Framework\TestCase;
 use Redmine\Api\IssueCategory;
-use Redmine\Client\Client;
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\UnexpectedResponseException;
-use Redmine\Tests\Fixtures\MockClient;
+use Redmine\Http\HttpClient;
+use Redmine\Tests\Fixtures\AssertingHttpClient;
 use Redmine\Tests\Fixtures\TestDataProvider;
 
 #[CoversClass(IssueCategory::class)]
@@ -22,21 +22,21 @@ public function testListByProjectWithoutParametersReturnsResponse(): void
         $response = '["API Response"]';
         $expectedReturn = ['API Response'];
 
-        // Create the used mock objects
-        $client = $this->createMock(Client::class);
-        $client->expects($this->once())
-            ->method('requestGet')
-            ->with('/projects/5/issue_categories.json')
-            ->willReturn(true);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseBody')
-            ->willReturn($response);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseContentType')
-            ->willReturn('application/json');
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/projects/5/issue_categories.json',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                $response,
+            ],
+        );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedReturn, $api->listByProject($projectId));
@@ -50,21 +50,21 @@ public function testListByProjectWithParametersReturnsResponse(): void
         $response = '["API Response"]';
         $expectedReturn = ['API Response'];
 
-        // Create the used mock objects
-        $client = $this->createMock(Client::class);
-        $client->expects($this->once())
-            ->method('requestGet')
-            ->with('/projects/project-slug/issue_categories.json?limit=25&offset=0&0=not-used')
-            ->willReturn(true);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseBody')
-            ->willReturn($response);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseContentType')
-            ->willReturn('application/json');
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/projects/project-slug/issue_categories.json?limit=25&offset=0&0=not-used',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                $response,
+            ],
+        );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedReturn, $api->listByProject($projectId, $parameters));
@@ -76,7 +76,7 @@ public function testListByProjectWithParametersReturnsResponse(): void
     #[DataProviderExternal(TestDataProvider::class, 'getInvalidProjectIdentifiers')]
     public function testListByProjectWithWrongProjectIdentifierThrowsException($projectIdentifier): void
     {
-        $api = new IssueCategory(MockClient::create());
+        $api = IssueCategory::fromHttpClient($this->createStub(HttpClient::class));
 
         $this->expectException(InvalidParameterException::class);
         $this->expectExceptionMessage('Redmine\Api\IssueCategory::listByProject(): Argument #1 ($projectIdentifier) must be of type int or string');
@@ -86,21 +86,21 @@ public function testListByProjectWithWrongProjectIdentifierThrowsException($proj
 
     public function testListByProjectThrowsException(): void
     {
-        // Create the used mock objects
-        $client = $this->createMock(Client::class);
-        $client->expects($this->exactly(1))
-            ->method('requestGet')
-            ->with('/projects/5/issue_categories.json')
-            ->willReturn(true);
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseBody')
-            ->willReturn('');
-        $client->expects($this->exactly(1))
-            ->method('getLastResponseContentType')
-            ->willReturn('application/json');
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/projects/5/issue_categories.json',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                '',
+            ],
+        );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         $this->expectException(UnexpectedResponseException::class);
         $this->expectExceptionMessage('The Redmine server replied with an unexpected response.');
diff --git a/tests/Unit/Api/IssueCategory/ListNamesByProjectTest.php b/tests/Unit/Api/IssueCategory/ListNamesByProjectTest.php
@@ -37,7 +37,7 @@ public function testListNamesByProjectReturnsCorrectResponse($projectIdentifier,
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedResponse, $api->listNamesByProject($projectIdentifier));
@@ -104,7 +104,7 @@ public function testListNamesByProjectCallsHttpClientOnlyOnce(): void
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame([1 => 'IssueCategory 1'], $api->listNamesByProject(5));
@@ -118,7 +118,7 @@ public function testListNamesByProjectCallsHttpClientOnlyOnce(): void
     #[DataProviderExternal(TestDataProvider::class, 'getInvalidProjectIdentifiers')]
     public function testListNamesByProjectWithWrongProjectIdentifierThrowsException($projectIdentifier): void
     {
-        $api = new IssueCategory($this->createMock(HttpClient::class));
+        $api = IssueCategory::fromHttpClient($this->createMock(HttpClient::class));
 
         $this->expectException(InvalidParameterException::class);
         $this->expectExceptionMessage('Redmine\Api\IssueCategory::listNamesByProject(): Argument #1 ($projectIdentifier) must be of type int or string');
diff --git a/tests/Unit/Api/IssueCategory/RemoveTest.php b/tests/Unit/Api/IssueCategory/RemoveTest.php
@@ -31,7 +31,7 @@ public function testRemoveReturnsCorrectResponse(int $issueId, array $params, st
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($response, $api->remove($issueId, $params));
diff --git a/tests/Unit/Api/IssueCategory/ShowTest.php b/tests/Unit/Api/IssueCategory/ShowTest.php
@@ -31,7 +31,7 @@ public function testShowReturnsCorrectResponse($id, string $expectedPath, string
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame($expectedReturn, $api->show($id));
diff --git a/tests/Unit/Api/IssueCategory/UpdateTest.php b/tests/Unit/Api/IssueCategory/UpdateTest.php
@@ -33,7 +33,7 @@ public function testUpdateReturnsCorrectResponse(int $id, array $parameters, str
         );
 
         // Create the object under test
-        $api = new IssueCategory($client);
+        $api = IssueCategory::fromHttpClient($client);
 
         // Perform the tests
         $this->assertSame('', $api->update($id, $parameters));
diff --git a/tests/Unit/Api/IssueCategoryTest.php b/tests/Unit/Api/IssueCategoryTest.php

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ final public static function fromHttpClient(HttpClient $httpClient): self`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* @deprecated v2.9.0 Use fromHttpClient() instead.`
`37`		`- * @see Issue::fromHttpClient()`
	`37`	`+ * @see CustomField::fromHttpClient()`
`38`	`38`	`*`
`39`	`39`	`* @param Client\|HttpClient $client`
`40`	`40`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ final public static function fromHttpClient(HttpClient $httpClient): self`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* @deprecated v2.9.0 Use fromHttpClient() instead.`
`43`		`- * @see Issue::fromHttpClient()`
	`43`	`+ * @see Group::fromHttpClient()`
`44`	`44`	`*`
`45`	`45`	`* @param Client\|HttpClient $client`
`46`	`46`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -522,7 +522,7 @@ private function getIssueCategoryApi()`
`522`	`522`	`/** @var IssueCategory */`
`523`	`523`	`$issueCategoryApi = $this->client->getApi('issue_category');`
`524`	`524`	`} else {`
`525`		`- $issueCategoryApi = new IssueCategory($this->getHttpClient());`
	`525`	`+ $issueCategoryApi = IssueCategory::fromHttpClient($this->getHttpClient());`
`526`	`526`	`}`
`527`	`527`
`528`	`528`	`$this->issueCategoryApi = $issueCategoryApi;`