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

Inheritance diagram for UserrightsPage:

Collaboration diagram for UserrightsPage:

Public Member Functions
	__construct ()

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

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

	doesWrites ()

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

	editUserGroupsForm ($username)
	Edit user groups membership. More...

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

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

	getSuccessURL ()

	isRestricted ()

	makeGroupNameList ($ids)

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

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

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

	userCanChangeRights ($user, $checkIfSelf=true)

	userCanExecute (User $user)

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

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

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

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

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

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

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

	getConfig ()
	Shortcut to get main config object. More...

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

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

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

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

	getLanguage ()
	Shortcut to get user's language. More...

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

	getName ()
	Get the name of this Special Page. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	run ($subPage)
	Entry point. More...

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

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

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

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

Protected Member Functions
	getGroupName ()

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

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

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

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

	afterExecute ($subPage)
	Gets called after. More...

	beforeExecute ($subPage)
	Gets called before. More...

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

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

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

	getRobotPolicy ()
	Return the robot policy. More...

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

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

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

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

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). More...

Protected Attributes
	$isself = false

	$mFetchedUser = null

	$mTarget

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

	$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. More...

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

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

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

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

Detailed Description

Special page to allow managing user group membership.

Definition at line 29 of file SpecialUserrights.php.

Constructor & Destructor Documentation

UserrightsPage::__construct ( )

Definition at line 40 of file SpecialUserrights.php.

Member Function Documentation

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 317 of file SpecialUserrights.php.

References $user, and SpecialPage\getUser().

Referenced by doSaveUserGroups().

static UserrightsPage::buildGroupLink ( $group )

staticprivate

Format a link to a group description page.

Parameters

string $group

Returns: string

Definition at line 619 of file SpecialUserrights.php.

References User\getGroupName(), and User\makeGroupLinkHTML().

static UserrightsPage::buildGroupMemberLink ( $group )

staticprivate

Format a link to a group member description page.

Parameters

string $group

Returns: string

Definition at line 629 of file SpecialUserrights.php.

References User\getGroupMember(), and User\makeGroupLinkHTML().

UserrightsPage::canAdd ( $group )

private

Parameters

string $group The name of the group to check

Returns: bool Can we add the group?

Definition at line 743 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes().

UserrightsPage::canRemove ( $group )

private

Parameters

string $group The name of the group to check

Returns: bool Can we remove the group?

Definition at line 729 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes().

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 762 of file SpecialUserrights.php.

References SpecialPage\getUser().

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

UserrightsPage::doesWrites ( )

Definition at line 44 of file SpecialUserrights.php.