Skip to content

Commit 0059a15

Browse files
Art4Art4
committed
Merge branch 'v2.x' into 384-deprecate-all-redmineapiissueprio_-constants
2 parents 751c48f + f62f766 commit 0059a15

20 files changed

+50
-25
lines changed

‎src/Redmine/Api/AbstractApi.php

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ final public function getLastResponse(): Response
8181
*
8282
* @return bool
8383
*
84-
* @deprecated since v2.1.0, because it does not correctly handle 2xx codes that are not 200 or 201, use `Redmine\Api\AbstractApi::getLastResponse()->getStatusCode()` instead
84+
* @deprecated v2.1.0 It does not correctly handle 2xx codes that are not 200 or 201, use `Redmine\Api\AbstractApi::getLastResponse()->getStatusCode()` instead
8585
* @see AbstractApi::getLastResponse()->getStatusCode() for checking the status code directly
8686
*/
8787
public function lastCallFailed()
@@ -102,7 +102,8 @@ public function lastCallFailed()
102102
/**
103103
* Perform the client get() method.
104104
*
105-
* @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead
105+
* @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead
106+
* @see \Redmine\Http\HttpClient::request()
106107
*
107108
* @param string $path
108109
* @param bool $decodeIfJson
@@ -141,7 +142,8 @@ protected function get($path, $decodeIfJson = true)
141142
/**
142143
* Perform the client post() method.
143144
*
144-
* @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead
145+
* @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead
146+
* @see \Redmine\Http\HttpClient::request()
145147
*
146148
* @param string $path
147149
* @param string $data
@@ -247,7 +249,8 @@ protected function sanitizeParams(array $defaults, array $params)
247249
* Retrieves all the elements of a given endpoint (even if the
248250
* total number of elements is greater than 100).
249251
*
250-
* @deprecated since v2.2.0, use `retrieveData()` instead
252+
* @deprecated v2.2.0 Use `retrieveData()` instead
253+
* @see AbstractApi::retrieveData()
251254
*
252255
* @param string $endpoint API end point
253256
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
@@ -347,7 +350,8 @@ protected function retrieveData(string $endpoint, array $params = []): array
347350
/**
348351
* Attaches Custom Fields to a create/update query.
349352
*
350-
* @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead
353+
* @deprecated v2.3.0 Use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead
354+
* @see \Redmine\Serializer\XmlSerializer::createFromArray()
351355
*
352356
* @param SimpleXMLElement $xml XML Element the custom fields are attached to
353357
* @param array $fields array of fields to attach, each field needs name, id and value set

‎src/Redmine/Api/CustomField.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ final public function list(array $params = []): array
4040
/**
4141
* List custom fields.
4242
*
43-
* @deprecated since v2.4.0, use list() instead.
43+
* @deprecated v2.4.0 Use list() instead.
44+
* @see CustomField::list()
4445
*
4546
* @see http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
4647
*

‎src/Redmine/Api/Group.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ final public function list(array $params = []): array
4646
/**
4747
* List groups.
4848
*
49-
* @deprecated since v2.4.0, use list() instead.
49+
* @deprecated v2.4.0 Use list() instead.
50+
* @see Group::list()
5051
*
5152
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET
5253
*

‎src/Redmine/Api/Issue.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ final public function list(array $params = []): array
105105
/**
106106
* List issues.
107107
*
108-
* @deprecated since v2.4.0, use list() instead.
108+
* @deprecated v2.4.0 Use list() instead.
109+
* @see Issue::list()
109110
*
110111
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Issues
111112
* available $params :

‎src/Redmine/Api/IssueCategory.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
5656
/**
5757
* List issue categories.
5858
*
59-
* @deprecated since v2.4.0, use listByProject() instead.
59+
* @deprecated v2.4.0 Use listByProject() instead.
60+
* @see IssueCategory::listByProject()
6061
*
6162
* @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET
6263
*

‎src/Redmine/Api/IssuePriority.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ final public function list(array $params = []): array
4040
/**
4141
* List issue priorities.
4242
*
43-
* @deprecated since v2.4.0, use list() instead.
43+
* @deprecated v2.4.0 Use list() instead.
44+
* @see IssuePriority::list()
4445
*
4546
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#enumerationsissue_prioritiesformat
4647
*

‎src/Redmine/Api/IssueRelation.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ final public function listByIssueId(int $issueId, array $params = []): array
4444
/**
4545
* List relations of the given issue.
4646
*
47-
* @deprecated since v2.4.0, use listByIssueId() instead.
47+
* @deprecated v2.4.0 Use listByIssueId() instead.
48+
* @see IssueRelation::listByIssueId()
4849
*
4950
* @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET
5051
*

‎src/Redmine/Api/IssueStatus.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ final public function list(array $params = []): array
4040
/**
4141
* List issue statuses.
4242
*
43-
* @deprecated since v2.4.0, use list() instead.
43+
* @deprecated v2.4.0 Use list() instead.
44+
* @see IssueStatus::list()
4445
*
4546
* @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses#GET
4647
*

‎src/Redmine/Api/Membership.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
5454
/**
5555
* List memberships for a given $project.
5656
*
57-
* @deprecated since v2.4.0, use listByProject() instead.
57+
* @deprecated v2.4.0 Use listByProject() instead.
58+
* @see Membership::listByProject()
5859
*
5960
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET
6061
*

‎src/Redmine/Api/News.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ final public function list(array $params = []): array
6868
/**
6969
* List news (if no $project is given, it will return ALL the news).
7070
*
71-
* @deprecated since v2.4.0, use list() or listByProject() instead.
71+
* @deprecated v2.4.0 Use list() or listByProject() instead.
72+
* @see News::list()
73+
* @see News::listByProject()
7274
*
7375
* @see http://www.redmine.org/projects/redmine/wiki/Rest_News#GET
7476
*

‎src/Redmine/Api/Project.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ final public function list(array $params = []): array
4747
/**
4848
* List projects.
4949
*
50-
* @deprecated since v2.4.0, use list() instead.
50+
* @deprecated v2.4.0 Use list() instead.
51+
* @see Project::list()
5152
*
5253
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Projects
5354
*
@@ -361,7 +362,8 @@ final public function unarchive($projectIdentifier): bool
361362
}
362363

363364
/**
364-
* @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.
365+
* @deprecated v2.3.0 Use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.
366+
* @see \Redmine\Serializer\XmlSerializer::createFromArray()
365367
*
366368
* @param array $params
367369
*

‎src/Redmine/Api/Query.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ final public function list(array $params = []): array
4040
/**
4141
* Returns the list of all custom queries visible by the user (public and private queries) for all projects.
4242
*
43-
* @deprecated since v2.4.0, use list() instead.
43+
* @deprecated v2.4.0 Use list() instead.
44+
* @see Query::list()
4445
*
4546
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Queries#GET
4647
*

‎src/Redmine/Api/Role.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ final public function list(array $params = []): array
4242
/**
4343
* List roles.
4444
*
45-
* @deprecated since v2.4.0, use list() instead.
45+
* @deprecated v2.4.0 Use list() instead.
46+
* @see Role::list()
4647
*
4748
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET
4849
*

‎src/Redmine/Api/Search.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ final public function listByQuery(string $query, array $params = []): array
3939
/**
4040
* Search.
4141
*
42-
* @deprecated since v2.4.0, use listByQuery() instead.
42+
* @deprecated v2.4.0 Use listByQuery() instead.
43+
* @see Search::listByQuery()
4344
*
4445
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Search
4546
*

‎src/Redmine/Api/TimeEntry.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ final public function list(array $params = []): array
4545
/**
4646
* List time entries.
4747
*
48-
* @deprecated since v2.4.0, use list() instead.
48+
* @deprecated v2.4.0 Use list() instead.
49+
* @see TimeEntry::list()
4950
*
5051
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
5152
*

‎src/Redmine/Api/TimeEntryActivity.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ final public function list(array $params = []): array
3838
/**
3939
* List time entry activities.
4040
*
41-
* @deprecated since v2.4.0, use list() instead.
41+
* @deprecated v2.4.0 Use list() instead.
42+
* @see TimeEntryActivity::list()
4243
*
4344
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
4445
*

‎src/Redmine/Api/Tracker.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ final public function list(array $params = []): array
4040
/**
4141
* List trackers.
4242
*
43-
* @deprecated since v2.4.0, use list() instead.
43+
* @deprecated v2.4.0 Use list() instead.
44+
* @see Tracker::list()
4445
*
4546
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Trackers#GET
4647
*

‎src/Redmine/Api/User.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ final public function list(array $params = []): array
4646
/**
4747
* List users.
4848
*
49-
* @deprecated since v2.4.0, use list() instead.
49+
* @deprecated v2.4.0 Use list() instead.
50+
* @see User::list()
5051
*
5152
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Users#GET
5253
*

‎src/Redmine/Api/Version.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
5454
/**
5555
* List versions.
5656
*
57-
* @deprecated since v2.4.0, use listByProject() instead.
57+
* @deprecated v2.4.0 Use listByProject() instead.
58+
* @see Version::listByProject()
5859
*
5960
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET
6061
*

‎src/Redmine/Api/Wiki.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
5353
/**
5454
* List wiki pages of given $project.
5555
*
56-
* @deprecated since v2.4.0, use listByProject() instead.
56+
* @deprecated v2.4.0 Use listByProject() instead.
57+
* @see Wiki::listByProject()
5758
*
5859
* @see http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-the-pages-list-of-a-wiki
5960
*

0 commit comments

Comments
 (0)