From 2e94e4d79064c9bafe04664fe51ff5d5e461288f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Thiemo=20M=C3=A4ttig?= Date: Wed, 27 Dec 2017 12:40:19 +0100 Subject: [PATCH] Document "arrays of UserGroupMembership objects" as such Change-Id: I3c60fb977a329e39933d50e275a738296bc17599 --- includes/specials/SpecialUserrights.php | 2 +- includes/specials/pagers/UsersPager.php | 6 +++--- includes/user/User.php | 4 ++-- includes/user/UserGroupMembership.php | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/specials/SpecialUserrights.php b/includes/specials/SpecialUserrights.php index a5f9ab3ec1..fd066ac7f3 100644 --- a/includes/specials/SpecialUserrights.php +++ b/includes/specials/SpecialUserrights.php @@ -761,7 +761,7 @@ class UserrightsPage extends SpecialPage { /** * Adds a table with checkboxes where you can select what groups to add/remove * - * @param array $usergroups Associative array of (group name as string => + * @param UserGroupMembership[] $usergroups Associative array of (group name as string => * UserGroupMembership object) for groups the user belongs to * @param User $user * @return Array with 2 elements: the XHTML table element with checkxboes, and diff --git a/includes/specials/pagers/UsersPager.php b/includes/specials/pagers/UsersPager.php index a68fe66881..45d9a7fc84 100644 --- a/includes/specials/pagers/UsersPager.php +++ b/includes/specials/pagers/UsersPager.php @@ -33,7 +33,7 @@ class UsersPager extends AlphabeticPager { /** - * @var array A array with user ids as key and a array of groups as value + * @var array[] A array with user ids as key and a array of groups as value */ protected $userGroupCache; @@ -391,8 +391,8 @@ class UsersPager extends AlphabeticPager { * and the relevant UserGroupMembership objects * * @param int $uid User id - * @param array|null $cache - * @return array (group name => UserGroupMembership object) + * @param array[]|null $cache + * @return UserGroupMembership[] (group name => UserGroupMembership object) */ protected static function getGroupMemberships( $uid, $cache = null ) { if ( $cache === null ) { diff --git a/includes/user/User.php b/includes/user/User.php index a4dfb2bba8..0d8ef89290 100644 --- a/includes/user/User.php +++ b/includes/user/User.php @@ -234,7 +234,7 @@ class User implements IDBAccessObject, UserIdentity { * @deprecated since 1.29 */ private $mGroups; - /** @var array Associative array of (group name => UserGroupMembership object) */ + /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */ protected $mGroupMemberships; /** @var array */ protected $mOptionOverrides; @@ -3317,7 +3317,7 @@ class User implements IDBAccessObject, UserIdentity { * Get the list of explicit group memberships this user has, stored as * UserGroupMembership objects. Implicit groups are not included. * - * @return array Associative array of (group name as string => UserGroupMembership object) + * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object) * @since 1.29 */ public function getGroupMemberships() { diff --git a/includes/user/UserGroupMembership.php b/includes/user/UserGroupMembership.php index a06be834c4..f771f4285e 100644 --- a/includes/user/UserGroupMembership.php +++ b/includes/user/UserGroupMembership.php @@ -276,7 +276,7 @@ class UserGroupMembership { * * @param int $userId ID of the user to search for * @param IDatabase|null $db Optional database connection - * @return array Associative array of (group name => UserGroupMembership object) + * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */ public static function getMembershipsForUser( $userId, IDatabase $db = null ) { if ( !$db ) { -- 2.20.1