MediaWiki REL1_37
|
A special page that allows users with 'block' right to block users from editing pages and other actions. More...
Public Member Functions | |
__construct (BlockUtils $blockUtils, BlockPermissionCheckerFactory $blockPermissionCheckerFactory, BlockUserFactory $blockUserFactory, UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, BlockActionInfo $blockActionInfo, TitleFormatter $titleFormatter, NamespaceInfo $namespaceInfo) | |
doesWrites () | |
Indicates whether this special page may perform database writes. | |
onSubmit (array $data, HTMLForm $form=null) | |
Process the form on POST submission. | |
onSuccess () | |
Do something exciting on successful processing of the form, most likely to show a confirmation message. | |
prefixSearchSubpages ( $search, $limit, $offset) | |
Return an array of subpages beginning with $search that this special page will accept. | |
requiresUnblock () | |
We allow certain special cases where user is blocked. | |
![]() | |
execute ( $par) | |
Basic SpecialPage workflow: get a form, send it to the user; get some data back,. | |
onSubmit (array $data) | |
Process the form on POST submission. | |
requiresWrite () | |
Whether this action requires the wiki not to be locked. | |
![]() | |
__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. | |
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 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. | |
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. | |
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 ( $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. | |
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) | |
setListed ( $listed) | |
Set whether this page is listed in Special:Specialpages, at run-time. | |
setSpecialPageFactory (SpecialPageFactory $specialPageFactory) | |
userCanExecute (User $user) | |
Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). | |
Static Public Member Functions | |
static | canBlockEmail (UserIdentity $user) |
Can we do an email block? | |
static | checkUnblockSelf ( $target, Authority $performer) |
T17810: Sitewide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826). | |
static | getSuggestedDurations (Language $lang=null, $includeOther=true) |
Get an array of suggested block durations from MediaWiki:Ipboptions. | |
static | getTargetAndType (?string $par, WebRequest $request=null) |
Get the target and type, given the request and the subpage parameter. | |
static | parseExpiryInput ( $expiry) |
Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database. | |
static | processForm (array $data, IContextSource $context) |
Given the form data, actually implement a block. | |
![]() | |
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. | |
Protected Member Functions | |
alterForm (HTMLForm $form) | |
Customizes the HTMLForm a bit. | |
checkExecutePermissions (User $user) | |
Checks that the user can unblock themselves if they are trying to do so. | |
getDisplayFormat () | |
Get display format for the form. | |
getFormFields () | |
Get the HTMLForm descriptor array for the block form. | |
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'. | |
maybeAlterFormDefaults (&$fields) | |
If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings. | |
postText () | |
Add footer elements to the form. | |
preText () | |
Add header elements like block log entries, etc. | |
setParameter ( $par) | |
Handle some magic here. | |
![]() | |
getForm () | |
Get the HTMLForm to control behavior. | |
getMessagePrefix () | |
Get message prefix for HTMLForm. | |
setReauthPostData (array $data) | |
Preserve POST data across reauthentication. | |
![]() | |
addFeedLinks ( $params) | |
Adds RSS/atom links. | |
afterExecute ( $subPage) | |
Gets called after. | |
beforeExecute ( $subPage) | |
Gets called before. | |
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 () | |
getLanguageConverter () | |
Shortcut to get language's converter. | |
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 Per 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! | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. | |
Static Protected Member Functions | |
static | getTargetUserTitle ( $target) |
Get a user page target for things like logs. | |
![]() | |
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 | |
bool | $alreadyBlocked |
array | $preErrors = [] |
User string | $previousTarget |
The previous block target. | |
bool | $requestedHideUser |
Whether the previous submission of the form asked for HideUser. | |
UserIdentity string null | $target |
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo) | |
int | $type |
DatabaseBlock::TYPE_ constant. | |
![]() | |
string null | $par = null |
The sub-page of the special page. | |
array null | $reauthPostData = null |
POST data preserved across re-authentication. | |
![]() | |
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 for the default. | |
string | $mRestriction |
Minimum user level required to access this page, or "" for anyone. | |
Static Private Member Functions | |
static | processFormInternal (array $data, Authority $performer, BlockUserFactory $blockUserFactory, BlockUtils $blockUtils) |
Implementation details for processForm Own function to allow sharing the deprecated code with non-deprecated and service code. | |
A special page that allows users with 'block' right to block users from editing pages and other actions.
Definition at line 48 of file SpecialBlock.php.
SpecialBlock::__construct | ( | BlockUtils | $blockUtils, |
BlockPermissionCheckerFactory | $blockPermissionCheckerFactory, | ||
BlockUserFactory | $blockUserFactory, | ||
UserNameUtils | $userNameUtils, | ||
UserNamePrefixSearch | $userNamePrefixSearch, | ||
BlockActionInfo | $blockActionInfo, | ||
TitleFormatter | $titleFormatter, | ||
NamespaceInfo | $namespaceInfo | ||
) |
BlockUtils | $blockUtils | |
BlockPermissionCheckerFactory | $blockPermissionCheckerFactory | |
BlockUserFactory | $blockUserFactory | |
UserNameUtils | $userNameUtils | |
UserNamePrefixSearch | $userNamePrefixSearch | |
BlockActionInfo | $blockActionInfo | |
TitleFormatter | $titleFormatter | |
NamespaceInfo | $namespaceInfo |
Definition at line 104 of file SpecialBlock.php.
|
protected |
Customizes the HTMLForm a bit.
HTMLForm | $form |
Reimplemented from FormSpecialPage.
Definition at line 183 of file SpecialBlock.php.
References $s, HTMLForm\addHeaderText(), SpecialPage\addHelpLink(), HTMLForm\formatErrors(), SpecialPage\getRequest(), HTMLForm\setHeaderText(), HTMLForm\setSubmitDestructive(), and HTMLForm\setSubmitTextMsg().
|
static |
Can we do an email block?
UserIdentity | $user | The sysop wanting to make a block |
Definition at line 999 of file SpecialBlock.php.
References User\newFromIdentity().
|
protected |
Checks that the user can unblock themselves if they are trying to do so.
User | $user |
ErrorPageError |
Reimplemented from FormSpecialPage.
Definition at line 136 of file SpecialBlock.php.
|
static |
T17810: Sitewide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826).
T208965: Partially blocked admins can block and unblock others as normal.
UserIdentity | string | null | $target | Target to block or unblock; could be a UserIdentity object, or username/IP address, or null when the target is not known yet (e.g. when displaying Special:Block) |
Authority | $performer | User doing the request |
Definition at line 1020 of file SpecialBlock.php.
References wfDeprecated().
SpecialBlock::doesWrites | ( | ) |
Indicates whether this special page may perform database writes.
Reimplemented from SpecialPage.
Definition at line 126 of file SpecialBlock.php.
|
protected |
Get display format for the form.
See HTMLForm documentation for available values.
Reimplemented from FormSpecialPage.
Definition at line 205 of file SpecialBlock.php.
|
protected |
Get the HTMLForm descriptor array for the block form.
Reimplemented from FormSpecialPage.
Definition at line 213 of file SpecialBlock.php.
References getAuthority(), SpecialPage\getConfig(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), SpecialPage\getUser(), maybeAlterFormDefaults(), and SpecialPage\msg().
|
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'.
Reimplemented from SpecialPage.
Definition at line 1079 of file SpecialBlock.php.
Get an array of suggested block durations from MediaWiki:Ipboptions.
Language | null | $lang | The language to get the durations in, or null to use the wiki's content language |
bool | $includeOther | Whether to include the 'other' option in the list of suggestions |
Definition at line 959 of file SpecialBlock.php.
References $lang, XmlSelect\parseOptionsMessage(), and wfMessage().
|
static |
Get the target and type, given the request and the subpage parameter.
Several parameters are handled for backwards compatability. 'wpTarget' is prioritized, since it matches the HTML form.
string | null | $par | Subpage parameter passed to setup, or data value from the HTMLForm |
WebRequest | null | $request | Optionally try and get data from a request too |
Definition at line 745 of file SpecialBlock.php.
|
staticprotected |
Get a user page target for things like logs.
This handles account and IP range targets.
UserIdentity | string | null | $target |
Definition at line 720 of file SpecialBlock.php.
References $target, MediaWiki\User\UserIdentity\getName(), and NS_USER.
|
protected |
If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings.
array | &$fields | HTMLForm descriptor array |
Definition at line 433 of file SpecialBlock.php.
References SpecialPage\getConfig(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getRequest(), MediaWiki\Block\Restriction\PageRestriction\getTitle(), MediaWiki\Block\DatabaseBlock\getType(), SpecialPage\getUser(), wfEscapeWikiText(), and wfTimestamp().
Referenced by getFormFields().
SpecialBlock::onSubmit | ( | array | $data, |
HTMLForm | $form = null |
||
) |
Process the form on POST submission.
array | $data | |
HTMLForm | null | $form |
Definition at line 1034 of file SpecialBlock.php.
References getAuthority().
SpecialBlock::onSuccess | ( | ) |
Do something exciting on successful processing of the form, most likely to show a confirmation message.
Reimplemented from FormSpecialPage.
Definition at line 1054 of file SpecialBlock.php.
References wfEscapeWikiText().
|
static |
Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database.
string | $expiry | Whatever was typed into the form |
Definition at line 988 of file SpecialBlock.php.
|
protected |
Add footer elements to the form.
Reimplemented from FormSpecialPage.
Definition at line 615 of file SpecialBlock.php.
References SpecialPage\$linkRenderer, getAuthority(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), getTitle(), SpecialPage\getTitleFor(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), SpecialPage\msg(), and wfEscapeWikiText().
SpecialBlock::prefixSearchSubpages | ( | $search, | |
$limit, | |||
$offset | |||
) |
Return an array of subpages beginning with $search that this special page will accept.
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) |
Reimplemented from SpecialPage.
Definition at line 1068 of file SpecialBlock.php.
|
protected |
Add header elements like block log entries, etc.
Reimplemented from FormSpecialPage.
Definition at line 565 of file SpecialBlock.php.
References $s, SpecialPage\getConfig(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), and SpecialPage\msg().
|
static |
Given the form data, actually implement a block.
array | $data | |
IContextSource | $context |
Definition at line 777 of file SpecialBlock.php.
References IContextSource\getAuthority().
|
staticprivate |
Implementation details for processForm Own function to allow sharing the deprecated code with non-deprecated and service code.
array | $data | |
Authority | $performer | |
BlockUserFactory | $blockUserFactory | |
BlockUtils | $blockUtils |
Definition at line 797 of file SpecialBlock.php.
References $title, $type, MediaWiki\Permissions\Authority\getUser(), MediaWiki\Block\BlockUserFactory\newBlockUser(), NS_USER, and MediaWiki\Block\BlockUtils\parseBlockTarget().
SpecialBlock::requiresUnblock | ( | ) |
We allow certain special cases where user is blocked.
Reimplemented from FormSpecialPage.
Definition at line 152 of file SpecialBlock.php.
|
protected |
Handle some magic here.
string | $par |
Reimplemented from FormSpecialPage.
Definition at line 161 of file SpecialBlock.php.
References FormSpecialPage\$par, SpecialPage\getRequest(), and SpecialPage\getSkin().
|
protected |
Definition at line 86 of file SpecialBlock.php.
|
private |
Definition at line 66 of file SpecialBlock.php.
|
private |
Definition at line 54 of file SpecialBlock.php.
|
private |
Definition at line 57 of file SpecialBlock.php.
|
private |
Definition at line 51 of file SpecialBlock.php.
|
private |
Definition at line 92 of file SpecialBlock.php.
|
protected |
Definition at line 89 of file SpecialBlock.php.
|
protected |
The previous block target.
Definition at line 80 of file SpecialBlock.php.
|
protected |
Whether the previous submission of the form asked for HideUser.
Definition at line 83 of file SpecialBlock.php.
|
protected |
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo)
Definition at line 74 of file SpecialBlock.php.
Referenced by getTargetUserTitle().
|
private |
Definition at line 69 of file SpecialBlock.php.
|
protected |
DatabaseBlock::TYPE_ constant.
Definition at line 77 of file SpecialBlock.php.
|
private |
Definition at line 63 of file SpecialBlock.php.
|
private |
Definition at line 60 of file SpecialBlock.php.