From f64ce549289f62b7c536f8f10f3231a27d3d9c41 Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Tue, 20 Dec 2022 20:47:46 +0100 Subject: [PATCH] user: Deprecate UserGroupMembership::getGroupMemberName Add @since to the replacement code (349819d) Also notice UserGroupMembership::getGroupName in release notes, there was no entry in the deprecation commit fb4e7a8 Bug: T325673 Follow-Up: Ib4990f87d4ad70b7525d7aa05c8b97e90c121674 Change-Id: Iae3a26dbc0b95b0d4edb59f03126295fc67c856e --- RELEASE-NOTES-1.40 | 3 +++ includes/Message/UserGroupMembershipParam.php | 3 +++ includes/language/Language.php | 2 ++ includes/user/UserGroupMembership.php | 2 ++ 4 files changed, 10 insertions(+) diff --git a/RELEASE-NOTES-1.40 b/RELEASE-NOTES-1.40 index 4e870134d80..c2d62c7e4ad 100644 --- a/RELEASE-NOTES-1.40 +++ b/RELEASE-NOTES-1.40 @@ -293,6 +293,9 @@ because of Phabricator reports. * IndexPager::getHookContainer is deprecated and emits deprecation warnings. Inject a HookContainer instead. * Global function wfShowingResults is deprecated and emits deprecation warnings. +* UserGroupMembership::getGroupMemberName is deprecated, the deprecation of + UserGroupMembership::getGroupName in 1.38 missed a release note. + Use Language::getGroupMemberName or ::getGroupName instead. * AbstractBlock::getPermissionsError(), deprecated in 1.35, now emits deprecation warnings. * The following functions are deprecated: isBlockedGlobally, getGlobalBlock. diff --git a/includes/Message/UserGroupMembershipParam.php b/includes/Message/UserGroupMembershipParam.php index c6e2e55baef..d9f5551cc04 100644 --- a/includes/Message/UserGroupMembershipParam.php +++ b/includes/Message/UserGroupMembershipParam.php @@ -26,6 +26,9 @@ namespace MediaWiki\Message; use MediaWiki\User\UserIdentity; use Stringable; +/** + * @since 1.38 + */ class UserGroupMembershipParam implements Stringable { /** @var string */ private $group; diff --git a/includes/language/Language.php b/includes/language/Language.php index 5340fc2b077..5b55b880822 100644 --- a/includes/language/Language.php +++ b/includes/language/Language.php @@ -2596,6 +2596,7 @@ class Language { * Gets the localized friendly name for a group, if it exists. For example, * "Administrators" or "Bureaucrats" * + * @since 1.38 * @param string $group Internal group name * @return string Localized friendly group name */ @@ -2608,6 +2609,7 @@ class Language { * Gets the localized name for a member of a group, if it exists. For example, * "administrator" or "bureaucrat" * + * @since 1.38 * @param string $group Internal group name * @param string|UserIdentity $member * @return string Localized name for group member diff --git a/includes/user/UserGroupMembership.php b/includes/user/UserGroupMembership.php index 668880c7503..f293a01e16f 100644 --- a/includes/user/UserGroupMembership.php +++ b/includes/user/UserGroupMembership.php @@ -178,6 +178,8 @@ class UserGroupMembership { * @param string $group Internal group name * @param string|UserIdentity $member Username or UserIdentity of member for gender * @return string Localized name for group member + * @deprecated since 1.40, use Language::getGroupMemberName or + * Message::objectParm with instance of UserGroupMembershipParam */ public static function getGroupMemberName( $group, $member ) { return RequestContext::getMain()->getLanguage()->getGroupMemberName( $group, $member );