jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/400393 )
Change subject: Document "arrays of UserGroupMembership objects" as such
......................................................................
Document "arrays of UserGroupMembership objects" as such
Change-Id: I3c60fb977a329e39933d50e275a738296bc17599
---
M includes/specials/SpecialUserrights.php
M includes/specials/pagers/UsersPager.php
M includes/user/User.php
M includes/user/UserGroupMembership.php
4 files changed, 7 insertions(+), 7 deletions(-)
Approvals:
Umherirrender: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/specials/SpecialUserrights.php
b/includes/specials/SpecialUserrights.php
index a5f9ab3..fd066ac 100644
--- a/includes/specials/SpecialUserrights.php
+++ b/includes/specials/SpecialUserrights.php
@@ -761,7 +761,7 @@
/**
* 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 a68fe66..45d9a7f 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 @@
* 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 a4dfb2b..0d8ef89 100644
--- a/includes/user/User.php
+++ b/includes/user/User.php
@@ -234,7 +234,7 @@
* @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 @@
* 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 a06be83..f771f42 100644
--- a/includes/user/UserGroupMembership.php
+++ b/includes/user/UserGroupMembership.php
@@ -276,7 +276,7 @@
*
* @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 ) {
--
To view, visit https://gerrit.wikimedia.org/r/400393
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I3c60fb977a329e39933d50e275a738296bc17599
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Thiemo Kreuz (WMDE) <[email protected]>
Gerrit-Reviewer: Bartosz Dziewoński <[email protected]>
Gerrit-Reviewer: Florianschmidtwelzow <[email protected]>
Gerrit-Reviewer: Umherirrender <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
