Special page to allow managing user group membership. More...

Inherits MediaWiki\SpecialPage\UserGroupsSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialUserRights:

[legend]

Public Member Functions
	__construct (private readonly UserGroupManagerFactory $userGroupManagerFactory, private readonly UserNameUtils $userNameUtils, private readonly UserNamePrefixSearch $userNamePrefixSearch, private readonly UserFactory $userFactory, private readonly WatchlistManager $watchlistManager, private readonly UserGroupAssignmentService $userGroupAssignmentService, private readonly MultiFormatUserIdentityLookup $multiFormatUserIdentityLookup, FormatterFactory $formatterFactory,)

	execute ( $subPage)
	Manage forms to be shown according to posted data.

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

Public Member Functions inherited from 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

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.

	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.

	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

buildFormExtraInfo ()

Allow subclasses to add extra information.

categorizeUserGroupsForDisplay (array $userGroups)

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'.

getTargetUserToolLinks ()

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.

saveUserGroups (string $reason, UserIdentity $user)

Save user groups changes in the database.

switchForm (string $target)

Display a HTMLUserTextField form to allow searching for a named user only.

Protected Member Functions inherited from MediaWiki\SpecialPage\UserGroupsSpecialPage

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.

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.

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

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
UserIdentity UserIdentity	$targetUser
	The user object of the target username.

Protected Attributes inherited from MediaWiki\SpecialPage\UserGroupsSpecialPage
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

Special page to allow managing user group membership.

Definition at line 37 of file SpecialUserRights.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialUserRights::__construct	(	private readonly UserGroupManagerFactory	$userGroupManagerFactory,
		private readonly UserNameUtils	$userNameUtils,
		private readonly UserNamePrefixSearch	$userNamePrefixSearch,
		private readonly UserFactory	$userFactory,
		private readonly WatchlistManager	$watchlistManager,
		private readonly UserGroupAssignmentService	$userGroupAssignmentService,
		private readonly MultiFormatUserIdentityLookup	$multiFormatUserIdentityLookup,
		FormatterFactory	$formatterFactory )

Definition at line 51 of file SpecialUserRights.php.

References MediaWiki\SpecialPage\SpecialPage\getContext(), and MediaWiki\Language\FormatterFactory\getStatusFormatter().

Member Function Documentation

◆ buildFormExtraInfo()

MediaWiki\Specials\SpecialUserRights::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 from MediaWiki\SpecialPage\UserGroupsSpecialPage.

Definition at line 286 of file SpecialUserRights.php.

◆ categorizeUserGroupsForDisplay()

MediaWiki\Specials\SpecialUserRights::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 from MediaWiki\SpecialPage\UserGroupsSpecialPage.

Definition at line 299 of file SpecialUserRights.php.

◆ execute()

MediaWiki\Specials\SpecialUserRights::execute ( $subPage )

Manage forms to be shown according to posted data.

Depending on the submit button used, call a form or a save function.

Parameters

string | null $subPage String if any subpage provided, else null

Exceptions

UserBlockedError|PermissionsError

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 72 of file SpecialUserRights.php.

◆ getTargetUserToolLinks()

MediaWiki\Specials\SpecialUserRights::getTargetUserToolLinks ( )

protected

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 from MediaWiki\SpecialPage\UserGroupsSpecialPage.

Definition at line 271 of file SpecialUserRights.php.

◆ prefixSearchSubpages()

MediaWiki\Specials\SpecialUserRights::prefixSearchSubpages	(	$search,
		$limit,
		$offset )

Return an array of subpages beginning with $search that this special page will accept.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 314 of file SpecialUserRights.php.

◆ saveUserGroups()

MediaWiki\Specials\SpecialUserRights::saveUserGroups	(	string	$reason,
		UserIdentity	$user )

protected

Save user groups changes in the database.

Data comes from the editUserGroupsForm() form function

Parameters

string	$reason	Reason for group change
UserIdentity	$user	The target user

Returns: Status

Definition at line 209 of file SpecialUserRights.php.

References MediaWiki\User\UserIdentity\getName(), MediaWiki\DAO\WikiAwareEntity\getWikiId(), and NS_USER.

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

◆ switchForm()

MediaWiki\Specials\SpecialUserRights::switchForm ( string $target )

protected

Display a HTMLUserTextField form to allow searching for a named user only.

Definition at line 243 of file SpecialUserRights.php.

References wfScript().

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

Member Data Documentation

◆ $targetUser

UserIdentity UserIdentity MediaWiki\Specials\SpecialUserRights::$targetUser

protected

The user object of the target username.

Definition at line 41 of file SpecialUserRights.php.

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

includes/Specials/SpecialUserRights.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFormExtraInfo()

◆ categorizeUserGroupsForDisplay()

◆ execute()

◆ getTargetUserToolLinks()

◆ prefixSearchSubpages()

◆ saveUserGroups()

◆ switchForm()

Member Data Documentation

◆ $targetUser