Skip to content

Commit 225b50f

Browse files
committed
update deprecation warnings
1 parent 6571679 commit 225b50f

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1818
### Deprecated
1919

2020
- Providing Argument #2 ($requestFactory) in `Redmine\Client\Psr18Client::__construct()` as type `Psr\Http\Message\ServerRequestFactoryInterface` is deprecated, provide as type `Psr\Http\Message\RequestFactoryInterface` instead
21-
- `Redmine\Api\AbstractApi::attachCustomFieldXML()` is deprecated
22-
- `Redmine\Api\Project::prepareParamsXml()` is deprecated
21+
- `Redmine\Api\AbstractApi::attachCustomFieldXML()` is deprecated, use `Redmine\Serializer\XmlSerializer::createFromArray()` instead
22+
- `Redmine\Api\Project::prepareParamsXml()` is deprecated, use `Redmine\Serializer\XmlSerializer::createFromArray()` instead
2323

2424
## [v2.2.0](https://github.com/kbsali/php-redmine-api/compare/v2.1.1...v2.2.0) - 2022-03-01
2525

src/Redmine/Api/AbstractApi.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ public function __construct(Client $client)
3232
*
3333
* @return bool
3434
*
35-
* @deprecated This method does not correctly handle 2xx codes that are not 200 or 201, use \Redmine\Client\Client::getLastResponseStatusCode() instead
35+
* @deprecated since v2.1.0, because it does not correctly handle 2xx codes that are not 200 or 201, use \Redmine\Client\Client::getLastResponseStatusCode() instead
3636
* @see Client::getLastResponseStatusCode() for checking the status code directly
3737
*/
3838
public function lastCallFailed()
3939
{
40-
@trigger_error('The '.__METHOD__.' method is deprecated, use \Redmine\Client\Client::getLastResponseStatusCode() instead.', E_USER_DEPRECATED);
40+
@trigger_error('`'.__METHOD__.'()` is deprecated since v2.1.0, use \Redmine\Client\Client::getLastResponseStatusCode() instead.', E_USER_DEPRECATED);
4141

4242
$code = $this->client->getLastResponseStatusCode();
4343

@@ -164,7 +164,7 @@ protected function sanitizeParams(array $defaults, array $params)
164164
* Retrieves all the elements of a given endpoint (even if the
165165
* total number of elements is greater than 100).
166166
*
167-
* @deprecated the `retrieveAll()` method is deprecated, use `retrieveData()` instead
167+
* @deprecated since v2.2.0, use `retrieveData()` instead
168168
*
169169
* @param string $endpoint API end point
170170
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
@@ -173,7 +173,7 @@ protected function sanitizeParams(array $defaults, array $params)
173173
*/
174174
protected function retrieveAll($endpoint, array $params = [])
175175
{
176-
@trigger_error('The '.__METHOD__.' method is deprecated, use `retrieveData()` instead.', E_USER_DEPRECATED);
176+
@trigger_error('`'.__METHOD__.'()` is deprecated since v2.2.0, use `retrieveData()` instead.', E_USER_DEPRECATED);
177177

178178
try {
179179
$data = $this->retrieveData(strval($endpoint), $params);
@@ -253,7 +253,7 @@ protected function retrieveData(string $endpoint, array $params = []): array
253253
/**
254254
* Attaches Custom Fields to a create/update query.
255255
*
256-
* @deprecated the `attachCustomFieldXML()` method is deprecated.
256+
* @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead
257257
*
258258
* @param SimpleXMLElement $xml XML Element the custom fields are attached to
259259
* @param array $fields array of fields to attach, each field needs name, id and value set
@@ -264,7 +264,7 @@ protected function retrieveData(string $endpoint, array $params = []): array
264264
*/
265265
protected function attachCustomFieldXML(SimpleXMLElement $xml, array $fields)
266266
{
267-
@trigger_error('The '.__METHOD__.' method is deprecated.', E_USER_DEPRECATED);
267+
@trigger_error('`'.__METHOD__.'()` is deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.', E_USER_DEPRECATED);
268268

269269
$_fields = $xml->addChild('custom_fields');
270270
$_fields->addAttribute('type', 'array');

src/Redmine/Api/Project.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,15 +156,15 @@ public function update($id, array $params)
156156
}
157157

158158
/**
159-
* @deprecated the `prepareParamsXml()` method is deprecated, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.
159+
* @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.
160160
*
161161
* @param array $params
162162
*
163163
* @return \SimpleXMLElement
164164
*/
165165
protected function prepareParamsXml($params)
166166
{
167-
@trigger_error('The '.__METHOD__.' method is deprecated, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.', E_USER_DEPRECATED);
167+
@trigger_error('`'.__METHOD__.'()` is deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.', E_USER_DEPRECATED);
168168

169169
return new \SimpleXMLElement(
170170
XmlSerializer::createFromArray(['project' => $params])->getEncoded()

0 commit comments

Comments
 (0)