add deprecated warnings in old client

Author: Art4

docs/migrate-to-nativecurlclient.md

@@ -107,7 +107,7 @@ This example shows how you can parse the response body of a DELETE request.
 
 ```diff
 -$dataAsString = $this->client->delete($path);
-+$this->client->requestDelte($path);
++$this->client->requestDelete($path);
 +$dataAsString = $this->client->getLastResponseBody();
 ```
 
@@ -237,7 +237,7 @@ test your code without errors and now simply switch the client.
 ```diff
 // Instantiate with ApiKey
 -$client = new \Redmine\Client(
-+$client = new \Redmine\Client\Prs18Client(
++$client = new \Redmine\Client\NativeCurlClient(
     'https://redmine.example.com',
     '1234567890abcdfgh'
 );

src/Redmine/Client.php

@@ -99,7 +99,7 @@ public function __construct($url, $apikeyOrUsername, $pass = null)
     /**
      * PHP getter magic method.
      *
-     * @deprecated
+     * @deprecated use getApi() instead
      *
      * @param string $name
      *
@@ -109,20 +109,24 @@ public function __construct($url, $apikeyOrUsername, $pass = null)
      */
     public function __get($name)
     {
-        return $this->api($name);
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use getApi() instead.', E_USER_DEPRECATED);
+
+        return $this->getApi(strval($name));
     }
 
     /**
      * @param string $name
      *
-     * @deprecated
+     * @deprecated use getApi() instead
      *
      * @throws \InvalidArgumentException
      *
      * @return Api\AbstractApi
      */
     public function api($name)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use getApi() instead.', E_USER_DEPRECATED);
+
         return $this->getApi(strval($name));
     }
 
@@ -135,6 +139,8 @@ public function api($name)
      */
     public function getUrl()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->url;
     }
 
@@ -205,7 +211,7 @@ public function getLastResponseBody(): string
     /**
      * HTTP GETs a json $path and tries to decode it.
      *
-     * @deprecated
+     * @deprecated use requestGet() instead
      *
      * @param string $path
      * @param bool   $decode
@@ -214,6 +220,8 @@ public function getLastResponseBody(): string
      */
     public function get($path, $decode = true)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use requestGet() instead.', E_USER_DEPRECATED);
+
         if (false === $json = $this->runRequest($path, 'GET')) {
             return false;
         }
@@ -239,6 +247,8 @@ public function get($path, $decode = true)
      */
     public function decode($json)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         if (empty($json)) {
             return '';
         }
@@ -256,7 +266,7 @@ public function decode($json)
     /**
      * HTTP POSTs $params to $path.
      *
-     * @deprecated
+     * @deprecated use requestPost() instead
      *
      * @param string $path
      * @param string $data
@@ -265,13 +275,15 @@ public function decode($json)
      */
     public function post($path, $data)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use requestPost() instead.', E_USER_DEPRECATED);
+
         return $this->runRequest($path, 'POST', $data);
     }
 
     /**
      * HTTP PUTs $params to $path.
      *
-     * @deprecated
+     * @deprecated use requestPut() instead
      *
      * @param string $path
      * @param string $data
@@ -280,34 +292,40 @@ public function post($path, $data)
      */
     public function put($path, $data)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use requestPut() instead.', E_USER_DEPRECATED);
+
         return $this->runRequest($path, 'PUT', $data);
     }
 
     /**
      * HTTP PUTs $params to $path.
      *
-     * @deprecated
+     * @deprecated use requestDelete() instead
      *
      * @param string $path
      *
      * @return false|\SimpleXMLElement|string
      */
     public function delete($path)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use requestDelete() instead.', E_USER_DEPRECATED);
+
         return $this->runRequest($path, 'DELETE');
     }
 
     /**
      * Turns on/off ssl certificate check.
      *
-     * @deprecated
+     * @deprecated use setCurlOption() instead
      *
      * @param bool $check
      *
      * @return Client
      */
     public function setCheckSslCertificate($check = false)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use setCurlOption() instead.', E_USER_DEPRECATED);
+
         $this->checkSslCertificate = $check;
 
         return $this;
@@ -322,20 +340,24 @@ public function setCheckSslCertificate($check = false)
      */
     public function getCheckSslCertificate()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->checkSslCertificate;
     }
 
     /**
      * Turns on/off ssl host certificate check.
      *
-     * @deprecated
+     * @deprecated use setCurlOption() instead
      *
      * @param bool $check
      *
      * @return Client
      */
     public function setCheckSslHost($check = false)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use setCurlOption() instead.', E_USER_DEPRECATED);
+
         $this->checkSslHost = (bool) $check;
 
         return $this;
@@ -350,13 +372,15 @@ public function setCheckSslHost($check = false)
      */
     public function getCheckSslHost()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->checkSslHost;
     }
 
     /**
      * Forces the SSL/TLS version to use.
      *
-     * @deprecated
+     * @deprecated use setCurlOption() instead
      * @see http://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html
      *
      * @param int $sslVersion
@@ -365,6 +389,8 @@ public function getCheckSslHost()
      */
     public function setSslVersion($sslVersion = 0)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use setCurlOption() instead.', E_USER_DEPRECATED);
+
         $this->sslVersion = $sslVersion;
 
         return $this;
@@ -379,20 +405,24 @@ public function setSslVersion($sslVersion = 0)
      */
     public function getSslVersion()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->sslVersion;
     }
 
     /**
      * Turns on/off http auth.
      *
-     * @deprecated
+     * @deprecated use setCurlOption() instead
      *
      * @param bool $use
      *
      * @return Client
      */
     public function setUseHttpAuth($use = true)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use setCurlOption() instead.', E_USER_DEPRECATED);
+
         $this->useHttpAuth = $use;
 
         return $this;
@@ -407,20 +437,24 @@ public function setUseHttpAuth($use = true)
      */
     public function getUseHttpAuth()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->useHttpAuth;
     }
 
     /**
      * Set the port of the connection.
      *
-     * @deprecated
+     * @deprecated use setCurlOption() instead
      *
      * @param int $port
      *
      * @return Client
      */
     public function setPort($port = null)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use setCurlOption() instead.', E_USER_DEPRECATED);
+
         if (null !== $port) {
             $this->port = (int) $port;
         }
@@ -431,13 +465,15 @@ public function setPort($port = null)
     /**
      * Returns Redmine response code.
      *
-     * @deprecated
+     * @deprecated use getLastResponseStatusCode() instead
      *
      * @return int
      */
     public function getResponseCode()
     {
-        return (int) $this->responseCode;
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use getLastResponseStatusCode() instead.', E_USER_DEPRECATED);
+
+        return (int) $this->getLastResponseStatusCode();
     }
 
     /**
@@ -451,11 +487,13 @@ public function getResponseCode()
      */
     public function getPort()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         if (null !== $this->port) {
             return $this->port;
         }
 
-        $tmp = parse_url($this->getUrl());
+        $tmp = parse_url($this->url);
         if (isset($tmp['port'])) {
             $this->setPort($tmp['port']);
         } elseif (isset($tmp['scheme'])) {
@@ -486,7 +524,7 @@ public function stopImpersonateUser(): void
      * Sets to an existing username so api calls can be
      * impersonated to this user.
      *
-     * @deprecated
+     * @deprecated use startImpersonateUser() and stopImpersonateUser() instead
      *
      * @param string|null $username
      *
@@ -495,8 +533,12 @@ public function stopImpersonateUser(): void
     public function setImpersonateUser($username = null)
     {
         if (null === $username) {
+            @trigger_error('The ' . __METHOD__ . ' method is deprecated, use stopImpersonateUser() instead.', E_USER_DEPRECATED);
+
             $this->stopImpersonateUser();
         } else {
+            @trigger_error('The ' . __METHOD__ . ' method is deprecated, use startImpersonateUser() instead.', E_USER_DEPRECATED);
+
             $this->startImpersonateUser($username);
         }
 
@@ -512,6 +554,8 @@ public function setImpersonateUser($username = null)
      */
     public function getImpersonateUser()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->impersonateUser;
     }
 
@@ -524,6 +568,8 @@ public function getImpersonateUser()
      */
     public function setCustomHost($customHost = null)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated, use setCurlOption() instead.', E_USER_DEPRECATED);
+
         $this->customHost = $customHost;
 
         return $this;
@@ -536,6 +582,8 @@ public function setCustomHost($customHost = null)
      */
     public function getCustomHost()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->customHost;
     }
 
@@ -577,6 +625,8 @@ public function unsetCurlOption($option)
      */
     public function getCurlOptions()
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         return $this->curlOptions;
     }
 
@@ -593,6 +643,8 @@ public function getCurlOptions()
      */
     public function prepareRequest($path, $method = 'GET', $data = '')
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         $this->responseCode = 0;
         $this->responseContentType = '';
         $this->responseBody = '';
@@ -724,6 +776,8 @@ private function setHttpHeader($path)
      */
     public function processCurlResponse($response, $contentType)
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         if ($response) {
             // if response is XML, return an SimpleXMLElement object
             if (0 === strpos($contentType, 'application/xml')) {
@@ -751,6 +805,8 @@ public function processCurlResponse($response, $contentType)
      */
     protected function runRequest($path, $method = 'GET', $data = '')
     {
+        @trigger_error('The ' . __METHOD__ . ' method is deprecated. You should stop using it, as it will be removed in the future.', E_USER_DEPRECATED);
+
         $curl = $this->prepareRequest($path, $method, $data);
 
         // use HTTP 1.1