Represents a "user group membership" – a specific instance of a user belonging to a group. More...

Public Member Functions
	__construct (int $userId=0, ?string $group=null, ?string $expiry=null)

	equals (UserGroupMembership $ugm)
	Compares two pure value objects.

	getExpiry ()

	getGroup ()

	getUserId ()

	isExpired ()
	Has the membership expired?

Static Public Member Functions
static	getGroupMemberName ( $group, $member)
	Gets the localized name for a member of a group, if it exists.

static	getGroupName ( $group)
	Gets the localized friendly name for a group, if it exists.

static	getGroupPage ( $group)
	Gets the title of a page describing a particular user group.

static	getLink ( $ugm, IContextSource $context, string $format, $userName=null)
	Gets a link for a user group, possibly including the expiry date if relevant.

static	getLinkHTML ( $ugm, IContextSource $context, $userName=null)
	Gets a link for a user group, possibly including the expiry date if relevant.

static	getLinkWiki ( $ugm, IContextSource $context, $userName=null)
	Gets a link for a user group, possibly including the expiry date if relevant.

Detailed Description

Represents a "user group membership" – a specific instance of a user belonging to a group.

For example, the fact that user Mary belongs to the sysop group is a user group membership.

The class is a pure value object. Use UserGroupManager to modify user group memberships.

Since: 1.29

Definition at line 41 of file UserGroupMembership.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\UserGroupMembership::__construct	(	int	$userId = 0,
		?string	$group = null,
		?string	$expiry = null )

Parameters

int	$userId	The ID of the user who belongs to the group
string \| null	$group	The internal group name
string \| null	$expiry	Timestamp of expiry in TS_MW format, or null if no expiry

Definition at line 60 of file UserGroupMembership.php.

References wfTimestampNow().

Member Function Documentation

◆ equals()

MediaWiki\User\UserGroupMembership::equals ( UserGroupMembership $ugm )

Compares two pure value objects.

Parameters

UserGroupMembership $ugm

Returns: bool

Since: 1.35

Definition at line 299 of file UserGroupMembership.php.

References MediaWiki\User\UserGroupMembership\getGroup(), and MediaWiki\User\UserGroupMembership\getUserId().

◆ getExpiry()

MediaWiki\User\UserGroupMembership::getExpiry ( )

Returns: string|null Timestamp of expiry in TS_MW format, or null if no expiry

Definition at line 84 of file UserGroupMembership.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ getGroup()

MediaWiki\User\UserGroupMembership::getGroup ( )

Returns: string

Definition at line 77 of file UserGroupMembership.php.

Referenced by MediaWiki\User\UserGroupMembership\equals().

◆ getGroupMemberName()

static MediaWiki\User\UserGroupMembership::getGroupMemberName	(		$group,
			$member )

static

Gets the localized name for a member of a group, if it exists.

For example, "administrator" or "bureaucrat"

Parameters

string	$group	Internal group name
string \| UserIdentity	$member	Username or UserIdentity of member for gender

Returns: string Localized name for group member

Deprecated: since 1.40, use Language::getGroupMemberName or Message::objectParm with instance of UserGroupMembershipParam, hard-deprecated in 1.41

Definition at line 268 of file UserGroupMembership.php.

References wfDeprecated().

◆ getGroupName()

static MediaWiki\User\UserGroupMembership::getGroupName ( $group )

static

Gets the localized friendly name for a group, if it exists.

For example, "Administrators" or "Bureaucrats"

Parameters

string $group Internal group name

Returns: string Localized friendly group name

Deprecated: since 1.38, use Language::getGroupName or Message::userGroupParams, hard-deprecated in 1.41

Definition at line 253 of file UserGroupMembership.php.

References wfDeprecated().

◆ getGroupPage()

static MediaWiki\User\UserGroupMembership::getGroupPage ( $group )

static

Gets the title of a page describing a particular user group.

When the name of the group appears in the UI, it can link to this page.

Parameters

string $group Internal group name

Returns: Title|false Title of the page if it exists, false otherwise

Definition at line 280 of file UserGroupMembership.php.

References wfMessage().

◆ getLink()

static MediaWiki\User\UserGroupMembership::getLink	(		$ugm,
		IContextSource	$context,
		string	$format,
			$userName = null )

static

Gets a link for a user group, possibly including the expiry date if relevant.

Deprecated: since 1.41 use getLinkWiki or getLinkHTML directly

Parameters

string \| UserGroupMembership	$ugm	Either a group name as a string, or a UserGroupMembership object
IContextSource	$context
string	$format	Either 'wiki' or 'html'
string \| null	$userName	If you want to use the group member message ("administrator"), pass the name of the user who belongs to the group; it is used for GENDER of the group member message. If you instead want the group name message ("Administrators"), omit this parameter.

Returns: string

Definition at line 112 of file UserGroupMembership.php.

References MediaWiki\User\UserGroupMembership\getLinkHTML(), and MediaWiki\User\UserGroupMembership\getLinkWiki().

◆ getLinkHTML()

static MediaWiki\User\UserGroupMembership::getLinkHTML	(		$ugm,
		IContextSource	$context,
			$userName = null )

static

Gets a link for a user group, possibly including the expiry date if relevant.

Since: 1.41

Parameters

string \| UserGroupMembership	$ugm	Either a group name as a string, or a UserGroupMembership object
IContextSource	$context
string \| null	$userName	If you want to use the group member message ("administrator"), pass the name of the user who belongs to the group; it is used for GENDER of the group member message. If you instead want the group name message ("Administrators"), omit this parameter.

Returns: string

Definition at line 137 of file UserGroupMembership.php.

Referenced by MediaWiki\User\UserGroupMembership\getLink().

◆ getLinkWiki()

static MediaWiki\User\UserGroupMembership::getLinkWiki	(		$ugm,
		IContextSource	$context,
			$userName = null )

static

Gets a link for a user group, possibly including the expiry date if relevant.

Since: 1.41

Parameters

string \| UserGroupMembership	$ugm	Either a group name as a string, or a UserGroupMembership object
IContextSource	$context
string \| null	$userName	If you want to use the group member message ("administrator"), pass the name of the user who belongs to the group; it is used for GENDER of the group member message. If you instead want the group name message ("Administrators"), omit this parameter.

Returns: string

Definition at line 178 of file UserGroupMembership.php.

Referenced by MediaWiki\User\UserGroupMembership\getLink().

◆ getUserId()

MediaWiki\User\UserGroupMembership::getUserId ( )

Returns: int

Definition at line 70 of file UserGroupMembership.php.

Referenced by MediaWiki\User\UserGroupMembership\equals().

◆ isExpired()

MediaWiki\User\UserGroupMembership::isExpired ( )

Has the membership expired?

Returns: bool

Definition at line 93 of file UserGroupMembership.php.

The documentation for this class was generated from the following file:

includes/user/UserGroupMembership.php

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ equals()

◆ getExpiry()

◆ getGroup()

◆ getGroupMemberName()

◆ getGroupName()

◆ getGroupPage()

◆ getLink()

◆ getLinkHTML()

◆ getLinkWiki()

◆ getUserId()

◆ isExpired()