A base class for special pages that allow to view and edit user groups. More...

Inherits MediaWiki\SpecialPage\SpecialPage.

Inherited by MediaWiki\Specials\SpecialUserRights.

Collaboration diagram for MediaWiki\SpecialPage\UserGroupsSpecialPage:

[legend]

Public Member Functions
	doesWrites ()
	Indicates whether POST requests to this special page require write access to the wiki.Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required. Stability: stable to override Returns bool Since 1.27

Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	execute ( $subPage)
	Default execute method Checks user permissions.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:SpecialPages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the canonical, unlocalized name of this special page without namespace.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getShortDescription (string $path='')
	Similar to SpecialPage::getDescription, but takes into account subpages and designed for display in tabs.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	addGroupAnnotation (string $group, Message\|string $annotation)
	Adds an annotation (message or message key) that should be displayed below the checkbox for the given group.

	addModules ()
	Adds ResourceLoader modules that are used by this page.

	buildFormExtraInfo ()
	Allow subclasses to add extra information.

	buildGroupsForm ()
	Builds the user groups form, either in view or edit mode.

	canAdd (string $group)
	Whether the current user can add the target user to the given group.

	canRemove (string $group)
	Whether the current user can remove the target user from the given group.

	categorizeUserGroupsForDisplay (array $userGroups)
	This function is invoked when constructing the "current user groups" part of the form.

	conflictOccured (?array $groupMembershipsPrimary=null)
	Tests if a conflict occurred when trying to save changes to user groups, by comparing the conflict check key received from the form with the expected one.

	getGroupAnnotations (string $group)
	Returns an array of annotations (messages or message keys) that should be displayed below the checkbox for the given group.

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. Stability: stable to override Returns string Since 1.21

	getTargetUserToolLinks ()
	Returns an HTML snippet with links to pages like user talk, contributions etc.

	makeConflictCheckKey (?array $groupMemberships=null)
	Returns a string that represents the current state of the target's groups.

	readGroupsForm ()
	Reads the user groups set in the form.

	setChangeableGroups (array $changeableGroups)
	Sets the groups that can be added and removed by the current user to/from the target user.

	setSuccessFlag ()
	Sets a flag in the session that the user rights were successfully saved.

	setTargetName (string $bareName, ?string $displayName=null)
	Sets the name of the target user.

	showLogFragment (string $logType, string $logSubType)
	Shows a log fragment for the current target user, i.e.

	showMessageOnSuccess ()
	If the session contains a flag that the user rights were successfully saved, shows a success message and removes the flag from the session.

	splitGroupsIntoAddRemove (array $newGroups, array $existingUGMs)
	Compares the current and new groups and splits them into groups to add, to remove, and prepares the new expiries of the groups in 'add'.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after `execute`.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	beforeExecute ( $subPage)
	Gets called before `execute`.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atEnd=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, ?SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
array array< string >	$addableGroups = []
	An array of group names that can be added by the current user to the current target.

bool bool	$enableWatchUser = true
	Whether the "Watch the user page" checkbox should be available on the page.

array list< string >	$explicitGroups = []
	An array of all explicit groups in the system.

array array< string, list< Message\|string > >	$groupAnnotations = []
	An array of group name => list of annotations to show below the group.

array array< string, UserGroupMembership >	$groupMemberships = []
	An array of group name => UserGroupMembership objects that the target user belongs to.

array array< string >	$removableGroups = []
	An array of group names that can be removed by the current user to the current target.

string string	$targetBareName = ''
	The bare name of the target user, e.g.

string string	$targetDisplayName = ''
	The display name of the target user, e.g.

Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used as the message key for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

static	newSearchPage (User $user)
	Get the users preferred search page.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

A base class for special pages that allow to view and edit user groups.

Stability: stable: to extend

Definition at line 32 of file UserGroupsSpecialPage.php.

Member Function Documentation

◆ addGroupAnnotation()

MediaWiki\SpecialPage\UserGroupsSpecialPage::addGroupAnnotation	(	string	$group,
		Message\|string	$annotation )

protected

Adds an annotation (message or message key) that should be displayed below the checkbox for the given group.

The annotation will be appended to any existing annotations for this group.

Definition at line 781 of file UserGroupsSpecialPage.php.

◆ addModules()

MediaWiki\SpecialPage\UserGroupsSpecialPage::addModules ( )

protected

Adds ResourceLoader modules that are used by this page.

Definition at line 110 of file UserGroupsSpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ buildFormExtraInfo()

MediaWiki\SpecialPage\UserGroupsSpecialPage::buildFormExtraInfo ( )

protected

Allow subclasses to add extra information.

This is displayed on the edit and view panels, after the lists of the target user's groups.

Returns: ?string Parsed HTML

Reimplemented in MediaWiki\Specials\SpecialUserRights.

Definition at line 192 of file UserGroupsSpecialPage.php.

◆ buildGroupsForm()

MediaWiki\SpecialPage\UserGroupsSpecialPage::buildGroupsForm ( )

protected

Builds the user groups form, either in view or edit mode.

Returns: string The HTML of the form

Definition at line 154 of file UserGroupsSpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ canAdd()

MediaWiki\SpecialPage\UserGroupsSpecialPage::canAdd ( string $group )

protected

Whether the current user can add the target user to the given group.

Definition at line 753 of file UserGroupsSpecialPage.php.

◆ canRemove()

MediaWiki\SpecialPage\UserGroupsSpecialPage::canRemove ( string $group )

protected

Whether the current user can remove the target user from the given group.

Definition at line 760 of file UserGroupsSpecialPage.php.

◆ categorizeUserGroupsForDisplay()

MediaWiki\SpecialPage\UserGroupsSpecialPage::categorizeUserGroupsForDisplay ( array $userGroups )

protected

This function is invoked when constructing the "current user groups" part of the form.

It can be overridden by the implementations to split the user groups into several paragraphs or add more groups to the list, which are not expected to be editable through the form.

Parameters

array<string,UserGroupMembership> $userGroups The user groups the target belongs to, in the same format as {

See also: $groupMemberships}. The groups are sorted in such a way that permanent memberships are after temporary ones.

Returns: array<string,list<UserGroupMembership|string>> List of groups to show, keyed by the message key to include at the beginning of the respective paragraph. The default implementation returns a single paragraph with all the groups, keyed by 'userrights-groupsmember'.

Reimplemented in MediaWiki\Specials\SpecialUserRights.

Definition at line 706 of file UserGroupsSpecialPage.php.

◆ conflictOccured()

MediaWiki\SpecialPage\UserGroupsSpecialPage::conflictOccured ( ?array $groupMembershipsPrimary = null )

protected

Tests if a conflict occurred when trying to save changes to user groups, by comparing the conflict check key received from the form with the expected one.

Parameters

?array<string,UserGroupMembership> $groupMembershipsPrimary The group memberships to use when generating the expected conflict check key. If null, defaults to the value of {

See also: $groupMemberships}. It's recommended to pass memberships fetched from the primary database, so that concurrent changes made by other requests are detected.

Definition at line 736 of file UserGroupsSpecialPage.php.

◆ doesWrites()

MediaWiki\SpecialPage\UserGroupsSpecialPage::doesWrites ( )

Indicates whether POST requests to this special page require write access to the wiki.Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 809 of file UserGroupsSpecialPage.php.

◆ getGroupAnnotations()

MediaWiki\SpecialPage\UserGroupsSpecialPage::getGroupAnnotations ( string $group )

protected

Returns an array of annotations (messages or message keys) that should be displayed below the checkbox for the given group.

The default implementation returns an empty array.

Annotations can signify special properties of the group, e.g. conditions required to grant this group or consequences of adding the user etc.

Returns: list<Message|string>

Definition at line 772 of file UserGroupsSpecialPage.php.

◆ getGroupName()

MediaWiki\SpecialPage\UserGroupsSpecialPage::getGroupName ( )

protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 817 of file UserGroupsSpecialPage.php.

◆ getTargetUserToolLinks()

MediaWiki\SpecialPage\UserGroupsSpecialPage::getTargetUserToolLinks ( )

abstractprotected

Returns an HTML snippet with links to pages like user talk, contributions etc.

for the target user. It will be used in the "Changing user groups of" header.

Reimplemented in MediaWiki\Specials\SpecialUserRights.

◆ makeConflictCheckKey()

MediaWiki\SpecialPage\UserGroupsSpecialPage::makeConflictCheckKey ( ?array $groupMemberships = null )

protected

Returns a string that represents the current state of the target's groups.

It is used to detect attempts of concurrent modifications to the user groups.

Parameters

?array<string,UserGroupMembership> $groupMemberships The group memberships to use in the conflict key generation. If null, defaults to the value of {

See also: $groupMemberships}. It's advised to use set this parameter to memberships fetched from the primary database when trying to detect conflicts on handling a request to save changes to user groups.

Definition at line 720 of file UserGroupsSpecialPage.php.

◆ readGroupsForm()

MediaWiki\SpecialPage\UserGroupsSpecialPage::readGroupsForm ( )

protected

Reads the user groups set in the form.

Returns them wrapped in a Status object. On success, the value is an array of group name => expiry pairs. The expiry is either a timestamp, null or 'existing' (meaning no change). On failure, the status is fatal and contains an appropriate error message.

NOTE: This method doesn't check whether the current user is actually allowed to add/remove the groups. Normally, the result doesn't contain groups that the user is not supposed to change.

Definition at line 527 of file UserGroupsSpecialPage.php.

References wfTimestampNow().

◆ setChangeableGroups()

MediaWiki\SpecialPage\UserGroupsSpecialPage::setChangeableGroups ( array $changeableGroups )

protected

Sets the groups that can be added and removed by the current user to/from the target user.

If there are any restricted groups, adds appropriate annotations for them. This method accepts the same input structure as returned by {

See also: UserGroupAssignmentService::getChangeableGroups()}.

Parameters

array{add:list<string>,remove:list<string>,restricted:array<string,array>} $changeableGroups

Definition at line 89 of file UserGroupsSpecialPage.php.

◆ setSuccessFlag()

MediaWiki\SpecialPage\UserGroupsSpecialPage::setSuccessFlag ( )

protected

Sets a flag in the session that the user rights were successfully saved.

Next requests can call {

See also: showMessageOnSuccess()} to show a success message.

Definition at line 145 of file UserGroupsSpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ setTargetName()

MediaWiki\SpecialPage\UserGroupsSpecialPage::setTargetName	(	string	$bareName,
		?string	$displayName = null )

protected

Sets the name of the target user.

If this page uses a special notation for the username (e.g. "Foo@wiki"), which is different from actual bare username, this additional form should be passed as the second parameter. The second form will be used in the interface messages and in the hidden target field in the groups form.

Parameters

string	$bareName	A form of the name that can be used with {{GENDER:}}
string \| null	$displayName	A form of the name that will be used as a value of the target field in the edit groups form. If null, $targetName is used.

Definition at line 78 of file UserGroupsSpecialPage.php.

◆ showLogFragment()

MediaWiki\SpecialPage\UserGroupsSpecialPage::showLogFragment	(	string	$logType,
		string	$logSubType )

protected

Shows a log fragment for the current target user, i.e.

page "User:{$this->targetDisplayName}".

Parameters

string	$logType	The type of the log to show
string	$logSubType	The subtype of the log to show

Definition at line 677 of file UserGroupsSpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ showMessageOnSuccess()

MediaWiki\SpecialPage\UserGroupsSpecialPage::showMessageOnSuccess ( )

protected

If the session contains a flag that the user rights were successfully saved, shows a success message and removes the flag from the session.

Definition at line 120 of file UserGroupsSpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ splitGroupsIntoAddRemove()

MediaWiki\SpecialPage\UserGroupsSpecialPage::splitGroupsIntoAddRemove	(	array	$newGroups,
		array	$existingUGMs )

protected

Compares the current and new groups and splits them into groups to add, to remove, and prepares the new expiries of the groups in 'add'.

If a group has its expiry changed, but the user is already a member of it, this group will be included in 'add' (to update the expiry).

Parameters

array<string,?string> $newGroups An array of group name => expiry pairs, as returned by {

See also: readGroupsForm()}. The expiry is either a timestamp, null (meaning infinity) or 'existing' (meaning no change).

Parameters

array<string,UserGroupMembership> $existingUGMs The current group memberships of the target user, in the same format as in {

See also: $groupMemberships}.

Returns: array{0:list<string>,1:list<string>,2:array<string,?string>} Respectively: the groups to add, to remove, and the expiries to set on the groups to add.

Definition at line 584 of file UserGroupsSpecialPage.php.

Member Data Documentation

◆ $addableGroups

array array<string> MediaWiki\SpecialPage\UserGroupsSpecialPage::$addableGroups = []

protected

An array of group names that can be added by the current user to the current target.

Definition at line 53 of file UserGroupsSpecialPage.php.

◆ $enableWatchUser

bool bool MediaWiki\SpecialPage\UserGroupsSpecialPage::$enableWatchUser = true

protected

Whether the "Watch the user page" checkbox should be available on the page.

Definition at line 62 of file UserGroupsSpecialPage.php.

◆ $explicitGroups

array list<string> MediaWiki\SpecialPage\UserGroupsSpecialPage::$explicitGroups = []

protected

An array of all explicit groups in the system.

Definition at line 44 of file UserGroupsSpecialPage.php.

◆ $groupAnnotations

array array<string,list<Message|string> > MediaWiki\SpecialPage\UserGroupsSpecialPage::$groupAnnotations = []

protected

An array of group name => list of annotations to show below the group.

Definition at line 59 of file UserGroupsSpecialPage.php.

◆ $groupMemberships

array array<string,UserGroupMembership> MediaWiki\SpecialPage\UserGroupsSpecialPage::$groupMemberships = []

protected

An array of group name => UserGroupMembership objects that the target user belongs to.

Definition at line 50 of file UserGroupsSpecialPage.php.

◆ $removableGroups

array array<string> MediaWiki\SpecialPage\UserGroupsSpecialPage::$removableGroups = []

protected

An array of group names that can be removed by the current user to the current target.

Definition at line 56 of file UserGroupsSpecialPage.php.

◆ $targetBareName

string string MediaWiki\SpecialPage\UserGroupsSpecialPage::$targetBareName = ''

protected

The bare name of the target user, e.g.

"Foo" in a form suitable for {{GENDER:}}

Definition at line 35 of file UserGroupsSpecialPage.php.

◆ $targetDisplayName

string string MediaWiki\SpecialPage\UserGroupsSpecialPage::$targetDisplayName = ''

protected

The display name of the target user, e.g.

"Foo", "Foo@wiki". It will also be used as a value for the hidden target field in the edit groups form.

Definition at line 41 of file UserGroupsSpecialPage.php.

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

includes/SpecialPage/UserGroupsSpecialPage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addGroupAnnotation()

◆ addModules()

◆ buildFormExtraInfo()

◆ buildGroupsForm()

◆ canAdd()

◆ canRemove()

◆ categorizeUserGroupsForDisplay()

◆ conflictOccured()

◆ doesWrites()

◆ getGroupAnnotations()

◆ getGroupName()

◆ getTargetUserToolLinks()

◆ makeConflictCheckKey()

◆ readGroupsForm()

◆ setChangeableGroups()

◆ setSuccessFlag()

◆ setTargetName()

◆ showLogFragment()

◆ showMessageOnSuccess()

◆ splitGroupsIntoAddRemove()

Member Data Documentation

◆ $addableGroups

◆ $enableWatchUser

◆ $explicitGroups

◆ $groupAnnotations

◆ $groupMemberships

◆ $removableGroups

◆ $targetBareName

◆ $targetDisplayName