feat: create TimeEntry::fromHttpClient() and TimeEntryActivity::fromHttpClient()

Author: Art4

src/Redmine/Api/TimeEntry.php

@@ -2,10 +2,12 @@
 
 namespace Redmine\Api;
 
+use Redmine\Client\Client;
 use Redmine\Exception;
 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\XmlSerializer;
@@ -20,6 +22,37 @@
  */
 class TimeEntry extends AbstractApi
 {
+    final public static function fromHttpClient(HttpClient $httpClient): self
+    {
+        return new self($httpClient, true);
+    }
+
+    /**
+     * @deprecated v2.9.0 Use fromHttpClient() instead.
+     * @see TimeEntry::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 time entries.
      *

src/Redmine/Api/TimeEntryActivity.php

@@ -2,9 +2,11 @@
 
 namespace Redmine\Api;
 
+use Redmine\Client\Client;
 use Redmine\Exception;
 use Redmine\Exception\SerializerException;
 use Redmine\Exception\UnexpectedResponseException;
+use Redmine\Http\HttpClient;
 
 /**
  * Listing time entry activities.
@@ -15,6 +17,11 @@
  */
 class TimeEntryActivity extends AbstractApi
 {
+    final public static function fromHttpClient(HttpClient $httpClient): self
+    {
+        return new self($httpClient, true);
+    }
+
     /**
      * @var null|array<mixed>
      */
@@ -25,6 +32,32 @@ class TimeEntryActivity extends AbstractApi
      */
     private ?array $timeEntryActivityNames = null;
 
+    /**
+     * @deprecated v2.9.0 Use fromHttpClient() instead.
+     * @see TimeEntryActivity::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 time entry activities.
      *

tests/Unit/Api/TimeEntry/FromHttpClientTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Redmine\Tests\Unit\Api\TimeEntry;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\TimeEntry;
+use Redmine\Http\HttpClient;
+
+#[CoversClass(TimeEntry::class)]
+class FromHttpClientTest extends TestCase
+{
+    public function testReturnsCorrectObject(): void
+    {
+        $httpClient = $this->createStub(HttpClient::class);
+
+        $api = TimeEntry::fromHttpClient($httpClient);
+
+        $this->assertInstanceOf(TimeEntry::class, $api);
+    }
+}

tests/Unit/Api/TimeEntryActivity/FromHttpClientTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Redmine\Tests\Unit\Api\TimeEntryActivity;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Redmine\Api\TimeEntryActivity;
+use Redmine\Http\HttpClient;
+
+#[CoversClass(TimeEntryActivity::class)]
+class FromHttpClientTest extends TestCase
+{
+    public function testReturnsCorrectObject(): void
+    {
+        $httpClient = $this->createStub(HttpClient::class);
+
+        $api = TimeEntryActivity::fromHttpClient($httpClient);
+
+        $this->assertInstanceOf(TimeEntryActivity::class, $api);
+    }
+}

tests/Unit/Api/TimeEntryActivityTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use Redmine\Api\TimeEntryActivity;
 use Redmine\Client\Client;
+use Redmine\Http\HttpClient;
 use Redmine\Tests\Fixtures\MockClient;
 
 /**
@@ -15,6 +16,44 @@
 #[CoversClass(TimeEntryActivity::class)]
 class TimeEntryActivityTest extends TestCase
 {
+    public function testExtendingTheClassTriggersDeprecationWarning(): void
+    {
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    'Class `Redmine\Api\TimeEntryActivity` will declared as final in v3.0.0, stop extending it.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        new class ($this->createStub(HttpClient::class)) extends TimeEntryActivity {};
+    }
+
+    public function testConstructorTriggersDeprecationWarning(): void
+    {
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    'Method `Redmine\Api\TimeEntryActivity::__construct()` is deprecated since v2.9.0 and will declared as private in v3.0.0, use `Redmine\Api\TimeEntryActivity::fromHttpClient()` instead.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        new TimeEntryActivity($this->createStub(HttpClient::class));
+    }
+
     /**
      * Test all().
      */

tests/Unit/Api/TimeEntryTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use Redmine\Api\TimeEntry;
 use Redmine\Client\Client;
+use Redmine\Http\HttpClient;
 use Redmine\Tests\Fixtures\MockClient;
 
 /**
@@ -15,6 +16,44 @@
 #[CoversClass(TimeEntry::class)]
 class TimeEntryTest extends TestCase
 {
+    public function testExtendingTheClassTriggersDeprecationWarning(): void
+    {
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    'Class `Redmine\Api\TimeEntry` will declared as final in v3.0.0, stop extending it.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        new class ($this->createStub(HttpClient::class)) extends TimeEntry {};
+    }
+
+    public function testConstructorTriggersDeprecationWarning(): void
+    {
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    'Method `Redmine\Api\TimeEntry::__construct()` is deprecated since v2.9.0 and will declared as private in v3.0.0, use `Redmine\Api\TimeEntry::fromHttpClient()` instead.',
+                    $errstr,
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED,
+        );
+
+        new TimeEntry($this->createStub(HttpClient::class));
+    }
+
     /**
      * Test all().
      */