Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix deprecated phpdoc tag, add see tags #387

Merged
merged 1 commit into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/Redmine/Api/AbstractApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ final public function getLastResponse(): Response
*
* @return bool
*
* @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
* @deprecated v2.1.0 It does not correctly handle 2xx codes that are not 200 or 201, use `Redmine\Api\AbstractApi::getLastResponse()->getStatusCode()` instead
* @see AbstractApi::getLastResponse()->getStatusCode() for checking the status code directly
*/
public function lastCallFailed()
Expand All @@ -102,7 +102,8 @@ public function lastCallFailed()
/**
* Perform the client get() method.
*
* @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead
* @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead
* @see \Redmine\Http\HttpClient::request()
*
* @param string $path
* @param bool $decodeIfJson
Expand Down Expand Up @@ -141,7 +142,8 @@ protected function get($path, $decodeIfJson = true)
/**
* Perform the client post() method.
*
* @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead
* @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead
* @see \Redmine\Http\HttpClient::request()
*
* @param string $path
* @param string $data
Expand Down Expand Up @@ -247,7 +249,8 @@ protected function sanitizeParams(array $defaults, array $params)
* Retrieves all the elements of a given endpoint (even if the
* total number of elements is greater than 100).
*
* @deprecated since v2.2.0, use `retrieveData()` instead
* @deprecated v2.2.0 Use `retrieveData()` instead
* @see AbstractApi::retrieveData()
*
* @param string $endpoint API end point
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
Expand Down Expand Up @@ -347,7 +350,8 @@ protected function retrieveData(string $endpoint, array $params = []): array
/**
* Attaches Custom Fields to a create/update query.
*
* @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead
* @deprecated v2.3.0 Use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead
* @see \Redmine\Serializer\XmlSerializer::createFromArray()
*
* @param SimpleXMLElement $xml XML Element the custom fields are attached to
* @param array $fields array of fields to attach, each field needs name, id and value set
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/CustomField.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ final public function list(array $params = []): array
/**
* List custom fields.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see CustomField::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Group.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ final public function list(array $params = []): array
/**
* List groups.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see Group::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Issue.php
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ final public function list(array $params = []): array
/**
* List issues.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see Issue::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Issues
* available $params :
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/IssueCategory.php
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
/**
* List issue categories.
*
* @deprecated since v2.4.0, use listByProject() instead.
* @deprecated v2.4.0 Use listByProject() instead.
* @see IssueCategory::listByProject()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/IssuePriority.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ final public function list(array $params = []): array
/**
* List issue priorities.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see IssuePriority::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#enumerationsissue_prioritiesformat
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/IssueRelation.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ final public function listByIssueId(int $issueId, array $params = []): array
/**
* List relations of the given issue.
*
* @deprecated since v2.4.0, use listByIssueId() instead.
* @deprecated v2.4.0 Use listByIssueId() instead.
* @see IssueRelation::listByIssueId()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/IssueStatus.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ final public function list(array $params = []): array
/**
* List issue statuses.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see IssueStatus::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Membership.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
/**
* List memberships for a given $project.
*
* @deprecated since v2.4.0, use listByProject() instead.
* @deprecated v2.4.0 Use listByProject() instead.
* @see Membership::listByProject()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET
*
Expand Down
4 changes: 3 additions & 1 deletion src/Redmine/Api/News.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ final public function list(array $params = []): array
/**
* List news (if no $project is given, it will return ALL the news).
*
* @deprecated since v2.4.0, use list() or listByProject() instead.
* @deprecated v2.4.0 Use list() or listByProject() instead.
* @see News::list()
* @see News::listByProject()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_News#GET
*
Expand Down
6 changes: 4 additions & 2 deletions src/Redmine/Api/Project.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ final public function list(array $params = []): array
/**
* List projects.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see Project::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Projects
*
Expand Down Expand Up @@ -361,7 +362,8 @@ final public function unarchive($projectIdentifier): bool
}

/**
* @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.
* @deprecated v2.3.0 Use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.
* @see \Redmine\Serializer\XmlSerializer::createFromArray()
*
* @param array $params
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Query.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ final public function list(array $params = []): array
/**
* Returns the list of all custom queries visible by the user (public and private queries) for all projects.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see Query::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Queries#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Role.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ final public function list(array $params = []): array
/**
* List roles.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see Role::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Search.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ final public function listByQuery(string $query, array $params = []): array
/**
* Search.
*
* @deprecated since v2.4.0, use listByQuery() instead.
* @deprecated v2.4.0 Use listByQuery() instead.
* @see Search::listByQuery()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Search
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/TimeEntry.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ final public function list(array $params = []): array
/**
* List time entries.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see TimeEntry::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/TimeEntryActivity.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ final public function list(array $params = []): array
/**
* List time entry activities.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see TimeEntryActivity::list()
*
* @param array $params optional parameters to be passed to the api (offset, limit, ...)
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Tracker.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ final public function list(array $params = []): array
/**
* List trackers.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see Tracker::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Trackers#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ final public function list(array $params = []): array
/**
* List users.
*
* @deprecated since v2.4.0, use list() instead.
* @deprecated v2.4.0 Use list() instead.
* @see User::list()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Users#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Version.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
/**
* List versions.
*
* @deprecated since v2.4.0, use listByProject() instead.
* @deprecated v2.4.0 Use listByProject() instead.
* @see Version::listByProject()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET
*
Expand Down
3 changes: 2 additions & 1 deletion src/Redmine/Api/Wiki.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
/**
* List wiki pages of given $project.
*
* @deprecated since v2.4.0, use listByProject() instead.
* @deprecated v2.4.0 Use listByProject() instead.
* @see Wiki::listByProject()
*
* @see http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-the-pages-list-of-a-wiki
*
Expand Down
Loading