[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/specials/ -> SpecialUserrights.php (summary)

Implements Special:Userrights This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 741 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

UserrightsPage:: (25 methods):
  __construct()
  isRestricted()
  userCanExecute()
  userCanChangeRights()
  execute()
  getSuccessURL()
  saveUserGroups()
  doSaveUserGroups()
  addLogEntry()
  editUserGroupsForm()
  fetchUser()
  makeGroupNameList()
  makeGroupNameListForLog()
  switchForm()
  splitGroups()
  showEditUserGroupsForm()
  buildGroupLink()
  buildGroupMemberLink()
  getAllGroups()
  groupCheckboxes()
  canRemove()
  canAdd()
  changeableGroups()
  showLogFragment()
  getGroupName()


Class: UserrightsPage  - X-Ref

Special page to allow managing user group membership

__construct()   X-Ref
No description

isRestricted()   X-Ref
No description

userCanExecute( User $user )   X-Ref
No description

userCanChangeRights( $user, $checkIfSelf = true )   X-Ref

param: User $user
param: bool $checkIfSelf
return: bool

execute( $par )   X-Ref
Manage forms to be shown according to posted data.
Depending on the submit button used, call a form or a save function.

param: string|null $par String if any subpage provided, else null

getSuccessURL()   X-Ref
No description

saveUserGroups( $username, $reason, $user )   X-Ref
Save user groups changes in the database.
Data comes from the editUserGroupsForm() form function

param: string $username Username to apply changes to.
param: string $reason Reason for group change
param: User|UserRightsProxy $user Target user object.
return: null

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

param: User $user
param: array $add Array of groups to add
param: array $remove Array of groups to remove
param: string $reason Reason for group change
return: array Tuple of added, then removed groups

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

param: User $user
param: array $oldGroups
param: array $newGroups
param: array $reason

editUserGroupsForm( $username )   X-Ref
Edit user groups membership

param: string $username Name of the user.

fetchUser( $username )   X-Ref
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
param: string $username
return: Status

makeGroupNameList( $ids )   X-Ref
No description

makeGroupNameListForLog( $ids )   X-Ref
Make a list of group names to be stored as parameter for log entries

param: array $ids
return: string

switchForm()   X-Ref
Output a form to allow searching for a user


splitGroups( $groups )   X-Ref
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.

param: array $groups List of groups the given user is in
return: array Tuple of addable, then removable groups

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

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

buildGroupLink( $group )   X-Ref
Format a link to a group description page

param: string $group
return: string

buildGroupMemberLink( $group )   X-Ref
Format a link to a group member description page

param: string $group
return: string

getAllGroups()   X-Ref
Returns an array of all groups that may be edited

return: array Array of groups that may be edited.

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

param: array $usergroups Groups the user belongs to
param: User $user
return: string XHTML table element with checkboxes

canRemove( $group )   X-Ref

param: string $group The name of the group to check
return: bool Can we remove the group?

canAdd( $group )   X-Ref

param: string $group The name of the group to check
return: bool Can we add the group?

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

return: array Array(

showLogFragment( $user, $output )   X-Ref
Show a rights log fragment for the specified user

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

getGroupName()   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1