Document "arrays of UserGroupMembership objects" as such

Change-Id: I3c60fb977a329e39933d50e275a738296bc17599
This commit is contained in:
Thiemo Mättig 2017-12-27 12:40:19 +01:00 committed by Umherirrender
parent 8eaee6fd06
commit 2e94e4d790
4 changed files with 7 additions and 7 deletions

View file

@ -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

View file

@ -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 ) {

View file

@ -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() {

View file

@ -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 ) {