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

Inheritance diagram for UserrightsPage:

Collaboration diagram for UserrightsPage:

[legend]

Public Member Functions
	__construct ()

	addLogEntry ( $user, $oldGroups, $newGroups, $reason)
	Add a rights log entry for an action.

	changeableGroups ()
	Returns $this->getUser()->changeableGroups()

	doesWrites ()
	Indicates whether this special page may perform database writes.

	doSaveUserGroups ( $user, $add, $remove, $reason='')
	Save user groups changes in the database.

	editUserGroupsForm ( $username)
	Edit user groups membership.

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

	fetchUser ( $username)
	Normalize the input username, which may be local or remote, and return a user (or proxy) object for manipulating it.

	getSuccessURL ()

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

	makeGroupNameList ( $ids)

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

	saveUserGroups ( $username, $reason, $user)
	Save user groups changes in the database.

	switchForm ()
	Output a form to allow searching for a user.

	userCanChangeRights ( $user, $checkIfSelf=true)

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

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

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

	getConfig ()
	Shortcut to get main config object.

	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 name of this Special Page.

	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.

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

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

	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.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

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

	msg ()
	Wrapper around wfMessage that sets the current context.

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

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

	run ( $subPage)
	Entry point.

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

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

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

Protected Member Functions
	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'.

	showEditUserGroupsForm ( $user, $groups)
	Show the form to edit group memberships.

	showLogFragment ( $user, $output)
	Show a rights log fragment for the specified user.

	splitGroups ( $groups)
	Go through used and available groups and return the ones that this form will be able to manipulate based on the current user's system permissions.

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

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

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

	getCacheTTL ()

	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.

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

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

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

Static Protected Member Functions
static	getAllGroups ()
	Returns an array of all groups that may be edited.

Static Protected Member Functions inherited from 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).

Protected Attributes
	$isself = false

	$mFetchedUser = null

	$mTarget
	The target of the local right-adjuster's interest.

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	canAdd ( $group)

	canRemove ( $group)

	groupCheckboxes ( $usergroups, $user)
	Adds a table with checkboxes where you can select what groups to add/remove.

Static Private Member Functions
static	buildGroupLink ( $group)
	Format a link to a group description page.

static	buildGroupMemberLink ( $group)
	Format a link to a group member description page.

Additional Inherited Members
Static Public Member Functions inherited from 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.

Detailed Description

Special page to allow managing user group membership.

Definition at line 29 of file SpecialUserrights.php.

Constructor & Destructor Documentation

◆ __construct()

UserrightsPage::__construct ( )

Definition at line 43 of file SpecialUserrights.php.

Member Function Documentation

◆ addLogEntry()

UserrightsPage::addLogEntry	(	$user,
		$oldGroups,
		$newGroups,
		$reason
	)

Add a rights log entry for an action.

Parameters

User	$user
array	$oldGroups
array	$newGroups
array	$reason

Definition at line 337 of file SpecialUserrights.php.

References $user, and SpecialPage\getUser().

Referenced by doSaveUserGroups().

◆ buildGroupLink()

static UserrightsPage::buildGroupLink ( $group )

staticprivate

Format a link to a group description page.

Parameters

string $group

Returns: string

Definition at line 639 of file SpecialUserrights.php.

Referenced by showEditUserGroupsForm().

◆ buildGroupMemberLink()

static UserrightsPage::buildGroupMemberLink ( $group )

staticprivate

Format a link to a group member description page.

Parameters

string $group

Returns: string

Definition at line 649 of file SpecialUserrights.php.

Referenced by showEditUserGroupsForm().

◆ canAdd()

UserrightsPage::canAdd ( $group )

private

Parameters

string $group The name of the group to check

Returns: bool Can we add the group?

Definition at line 763 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes().

◆ canRemove()

UserrightsPage::canRemove ( $group )

private

Parameters

string $group The name of the group to check

Returns: bool Can we remove the group?

Definition at line 749 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes().

◆ changeableGroups()

UserrightsPage::changeableGroups ( )

Returns $this->getUser()->changeableGroups()

Returns: array Array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ), 'add-self' => array( addablegroups to self ), 'remove-self' => array( removable groups from self ) )

Definition at line 782 of file SpecialUserrights.php.

References SpecialPage\getUser().

Referenced by canAdd(), canRemove(), doSaveUserGroups(), execute(), splitGroups(), and userCanChangeRights().

◆ doesWrites()

UserrightsPage::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 47 of file SpecialUserrights.php.

◆ doSaveUserGroups()

UserrightsPage::doSaveUserGroups	(	$user,
		$add,
		$remove,
		$reason = `''`
	)

Save user groups changes in the database.

Parameters

User \| UserRightsProxy	$user
array	$add	Array of groups to add
array	$remove	Array of groups to remove
string	$reason	Reason for group change

Returns: array Tuple of added, then removed groups

Definition at line 272 of file SpecialUserrights.php.

References $isself, $user, addLogEntry(), array(), as, changeableGroups(), SpecialPage\getUser(), and wfDebug().

Referenced by saveUserGroups().

◆ editUserGroupsForm()

UserrightsPage::editUserGroupsForm ( $username )

Edit user groups membership.

Parameters

string $username Name of the user.

Definition at line 354 of file SpecialUserrights.php.

References $status, $user, $username, fetchUser(), SpecialPage\getOutput(), showEditUserGroupsForm(), and showLogFragment().

Referenced by execute().

◆ execute()

UserrightsPage::execute ( $par )

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 $par String if any subpage provided, else null

Exceptions

UserBlockedError|PermissionsError

Reimplemented from SpecialPage.

Definition at line 84 of file SpecialUserrights.php.

References $mFetchedUser, $out, $request, $user, SpecialPage\addHelpLink(), changeableGroups(), SpecialPage\checkReadOnly(), editUserGroupsForm(), fetchUser(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getSkin(), getSuccessURL(), SpecialPage\getUser(), SpecialPage\msg(), SpecialPage\outputHeader(), saveUserGroups(), SpecialPage\setHeaders(), switchForm(), and userCanChangeRights().

◆ fetchUser()

UserrightsPage::fetchUser ( $username )

Normalize the input username, which may be local or remote, and return a user (or proxy) object for manipulating it.

Side effects: error output for invalid access

Parameters

string $username

Returns: Status

Definition at line 381 of file SpecialUserrights.php.

References $name, $user, $username, SpecialPage\getConfig(), SpecialPage\getUser(), list, UserRightsProxy\newFromName(), UserRightsProxy\validDatabase(), wfWikiID(), and UserRightsProxy\whoIs().

Referenced by editUserGroupsForm(), and execute().

◆ getAllGroups()

static UserrightsPage::getAllGroups ( )

staticprotected

Returns an array of all groups that may be edited.

Returns: array Array of groups that may be edited.

Definition at line 657 of file SpecialUserrights.php.

Referenced by groupCheckboxes(), and saveUserGroups().

◆ getGroupName()

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

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 816 of file SpecialUserrights.php.

◆ getSuccessURL()

UserrightsPage::getSuccessURL ( )

Definition at line 230 of file SpecialUserrights.php.

References SpecialPage\getPageTitle().

Referenced by execute().

◆ groupCheckboxes()

UserrightsPage::groupCheckboxes	(	$usergroups,
		$user
	)

private

Adds a table with checkboxes where you can select what groups to add/remove.

Todo:: Just pass the username string?

Parameters

array	$usergroups	Groups the user belongs to
User	$user

Returns: string XHTML table element with checkboxes

Definition at line 669 of file SpecialUserrights.php.

References $name, $ret, $user, as, canAdd(), canRemove(), Xml\checkLabel(), Xml\closeElement(), Xml\element(), getAllGroups(), SpecialPage\msg(), Xml\openElement(), Xml\tags(), and text.

◆ isRestricted()

UserrightsPage::isRestricted ( )

Can be overridden by subclasses with more complicated permissions schemes.

Returns: bool Should the page be displayed with the restricted-access pages?

Reimplemented from SpecialPage.

Definition at line 51 of file SpecialUserrights.php.

◆ makeGroupNameList()

UserrightsPage::makeGroupNameList ( $ids )

Since: 1.15

Parameters

array $ids

Returns: string

Definition at line 447 of file SpecialUserrights.php.

References SpecialPage\msg().

◆ prefixSearchSubpages()

UserrightsPage::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 SpecialPage.

Definition at line 806 of file SpecialUserrights.php.

References $limit, $user, and UserNamePrefixSearch\search().

◆ saveUserGroups()

UserrightsPage::saveUserGroups	(	$username,
		$reason,
		$user
	)

Save user groups changes in the database.

Data comes from the editUserGroupsForm() form function

Parameters

string	$username	Username to apply changes to.
string	$reason	Reason for group change
User \| UserRightsProxy	$user	Target user object.

Returns: null

Definition at line 243 of file SpecialUserrights.php.

References $user, as, doSaveUserGroups(), getAllGroups(), and SpecialPage\getRequest().

Referenced by execute().

◆ showEditUserGroupsForm()

UserrightsPage::showEditUserGroupsForm	(	$user,
		$groups
	)

protected

Show the form to edit group memberships.

Parameters

User \| UserRightsProxy	$user	User or UserRightsProxy you're editing
array	$groups	Array of groups the user is in

Definition at line 526 of file SpecialUserrights.php.

References $count, $user, as, buildGroupLink(), buildGroupMemberLink(), Xml\closeElement(), Xml\element(), Autopromote\getAutopromoteGroups(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), Xml\input(), Xml\label(), SpecialPage\msg(), Xml\openElement(), Xml\submitButton(), Linker\TOOL_LINKS_EMAIL, Linker\tooltipAndAccesskeyAttribs(), Linker\userToolLinks(), and wfEscapeWikiText().

Referenced by editUserGroupsForm().

◆ showLogFragment()

UserrightsPage::showLogFragment	(	$user,
		$output
	)

protected

Show a rights log fragment for the specified user.

Parameters

User	$user	User to show log for
OutputPage	$output	OutputPage to use

Definition at line 792 of file SpecialUserrights.php.

References $output, $user, Xml\element(), and LogEventsList\showLogExtract().

Referenced by editUserGroupsForm().

◆ splitGroups()

UserrightsPage::splitGroups ( $groups )

protected

Go through used and available groups and return the ones that this form will be able to manipulate based on the current user's system permissions.

Parameters

array $groups List of groups the given user is in

Returns: array Tuple of addable, then removable groups

Definition at line 505 of file SpecialUserrights.php.

References changeableGroups(), and list.

◆ switchForm()

UserrightsPage::switchForm ( )

Output a form to allow searching for a user.

Definition at line 458 of file SpecialUserrights.php.

References Xml\fieldset(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Xml\inputLabel(), SpecialPage\msg(), Xml\submitButton(), text, and wfScript().

Referenced by execute().

◆ userCanChangeRights()

UserrightsPage::userCanChangeRights	(	$user,
		$checkIfSelf = `true`
	)

Parameters

User	$user
bool	$checkIfSelf

Returns: bool

Definition at line 64 of file SpecialUserrights.php.

References $user, and changeableGroups().

Referenced by execute(), and userCanExecute().

◆ userCanExecute()

UserrightsPage::userCanExecute ( User $user )

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

Can be overridden by sub- classes with more complicated permissions schemes.

Parameters

User $user The user to check

Returns: bool Does the user have permission to view the page?

Reimplemented from SpecialPage.

Definition at line 55 of file SpecialUserrights.php.

References userCanChangeRights().

Member Data Documentation

◆ $isself

UserrightsPage::$isself = false

protected

Definition at line 41 of file SpecialUserrights.php.

Referenced by doSaveUserGroups().

◆ $mFetchedUser

UserrightsPage::$mFetchedUser = null

protected

Definition at line 40 of file SpecialUserrights.php.

Referenced by execute().

◆ $mTarget

null string UserrightsPage::$mTarget

protected

The target of the local right-adjuster's interest.

Can be gotten from either a GET parameter or a subpage-style parameter, so have a member variable for it.

Definition at line 36 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

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLogEntry()

◆ buildGroupLink()

◆ buildGroupMemberLink()

◆ canAdd()

◆ canRemove()

◆ changeableGroups()

◆ doesWrites()

◆ doSaveUserGroups()

◆ editUserGroupsForm()

◆ execute()

◆ fetchUser()

◆ getAllGroups()

◆ getGroupName()

◆ getSuccessURL()

◆ groupCheckboxes()

◆ isRestricted()

◆ makeGroupNameList()

◆ prefixSearchSubpages()

◆ saveUserGroups()

◆ showEditUserGroupsForm()

◆ showLogFragment()

◆ splitGroups()

◆ switchForm()

◆ userCanChangeRights()

◆ userCanExecute()

Member Data Documentation

◆ $isself

◆ $mFetchedUser

◆ $mTarget