Deprecate AbstractApi::put()

Author: Art4

CHANGELOG.md

@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `Redmine\Api\AbstractApi::get()` is deprecated, use `\Redmine\Http\HttpClient::request()` instead.
 - `Redmine\Api\AbstractApi::post()` is deprecated, use `\Redmine\Http\HttpClient::request()` instead.
+- `Redmine\Api\AbstractApi::put()` is deprecated, use `\Redmine\Http\HttpClient::request()` instead.
 - The constant `Redmine\Api\Issue::PRIO_LOW` is deprecated.
 - The constant `Redmine\Api\Issue::PRIO_NORMAL` is deprecated.
 - The constant `Redmine\Api\Issue::PRIO_HIGH` is deprecated.

src/Redmine/Api/AbstractApi.php

@@ -175,13 +175,18 @@ protected function post($path, $data)
     /**
      * Perform the client put() method.
      *
+     * @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead
+     * @see \Redmine\Http\HttpClient::request()
+     *
      * @param string $path
      * @param string $data
      *
      * @return string|SimpleXMLElement
      */
     protected function put($path, $data)
     {
+        @trigger_error('`' . __METHOD__ . '()` is deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead.', E_USER_DEPRECATED);
+
         $this->lastResponse = $this->getHttpClient()->request(HttpFactory::makeRequest(
             'PUT',
             strval($path),

tests/Unit/Api/AbstractApiTest.php

@@ -125,6 +125,37 @@ function ($errno, $errstr): bool {
         $api->runPost('/path.json', 'data');
     }
 
+    /**
+     * @covers ::put
+     */
+    public function testPutTriggersDeprecationWarning()
+    {
+        $client = $this->createMock(HttpClient::class);
+
+        $api = new class ($client) extends AbstractApi {
+            public function runPut($path, $data)
+            {
+                return $this->put($path, $data);
+            }
+        };
+
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    '`Redmine\Api\AbstractApi::put()` is deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead.',
+                    $errstr
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED
+        );
+
+        $api->runPut('/path.json', 'data');
+    }
+
     /**
      * @test
      * @dataProvider getIsNotNullReturnsCorrectBooleanData