MediaWiki REL1_41
|
A special page that allows users with 'block' right to block users from editing pages and other actions. More...
Inherits MediaWiki\SpecialPage\FormSpecialPage.
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. | |
Public Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage | |
execute ( $par) | |
Basic SpecialPage workflow: get a form, send it to the user; get some data back,. | |
onSubmit (array $data) | |
Process the form on submission. | |
requiresPost () | |
Whether this action should using POST method to submit, default to true. | |
requiresWrite () | |
Whether this action requires the wiki not to be locked, default to requiresPost() | |
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 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. | |
getShortDescription (string $path='') | |
Similar to getDescription but takes into account sub pages 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. | |
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. | |
requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | |
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) | |
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 | 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 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. | |
Protected Member Functions | |
alterForm (HTMLForm $form) | |
Customizes the HTMLForm a bit. | |
checkExecutePermissions (User $user) | |
Check 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. | |
postHtml () | |
Add footer elements to the form. | |
preHtml () | |
Add header elements like block log entries, etc. | |
setParameter ( $par) | |
Handle some magic here. | |
Protected Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage | |
getForm () | |
Get the HTMLForm to control behavior. | |
getMessagePrefix () | |
Get message prefix for HTMLForm. | |
getShowAlways () | |
Whether the form should always be shown despite the success of submission. | |
getSubpageField () | |
Override this function to set the field name used in the subpage syntax. | |
postText () | |
Add post-text to the form. | |
preText () | |
Add pre-text to the form. | |
setReauthPostData (array $data) | |
Preserve POST data across reauthentication. | |
Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
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 () | |
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 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). | |
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. | |
Protected Attributes inherited from MediaWiki\SpecialPage\FormSpecialPage | |
string null | $par = null |
The sub-page of the special page. | |
array null | $reauthPostData = null |
POST data preserved across re-authentication. | |
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. | |
A special page that allows users with 'block' right to block users from editing pages and other actions.
Definition at line 73 of file SpecialBlock.php.
MediaWiki\Specials\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 118 of file SpecialBlock.php.
|
protected |
Customizes the HTMLForm a bit.
HTMLForm | $form |
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 197 of file SpecialBlock.php.
References MediaWiki\Specials\SpecialBlock\$preErrors, HTMLForm\addHeaderHtml(), MediaWiki\SpecialPage\SpecialPage\addHelpLink(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\msg(), HTMLForm\setHeaderHtml(), HTMLForm\setSubmitDestructive(), and HTMLForm\setSubmitTextMsg().
|
static |
Can we do an email block?
UserIdentity | $user | The sysop wanting to make a block |
Definition at line 1011 of file SpecialBlock.php.
References MediaWiki\MediaWikiServices\getInstance().
|
protected |
Check that the user can unblock themselves if they are trying to do so.
User | $user |
ErrorPageError |
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 150 of file SpecialBlock.php.
MediaWiki\Specials\SpecialBlock::doesWrites | ( | ) |
Indicates whether this special page may perform database writes.
Reimplemented from MediaWiki\SpecialPage\SpecialPage.
Definition at line 140 of file SpecialBlock.php.
|
protected |
Get display format for the form.
See HTMLForm documentation for available values.
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 222 of file SpecialBlock.php.
|
protected |
Get the HTMLForm descriptor array for the block form.
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 230 of file SpecialBlock.php.
References MediaWiki\MainConfigNames\AutoblockExpiry, MediaWiki\MainConfigNames\BlockAllowsUTEdit, Message\durationParam(), MediaWiki\MainConfigNames\EnablePartialActionBlocks, MediaWiki\SpecialPage\SpecialPage\getAuthority(), MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\Specials\SpecialBlock\getSuggestedDurations(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), and MediaWiki\SpecialPage\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 MediaWiki\SpecialPage\SpecialPage.
Definition at line 1062 of file SpecialBlock.php.
|
static |
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 971 of file SpecialBlock.php.
References wfMessage().
Referenced by MediaWiki\Specials\SpecialBlock\getFormFields().
|
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 748 of file SpecialBlock.php.
References wfDeprecated().
|
staticprotected |
Get a user page target for things like logs.
This handles account and IP range targets.
UserIdentity | string | null | $target |
Definition at line 722 of file SpecialBlock.php.
References MediaWiki\Specials\SpecialBlock\$target, MediaWiki\User\UserIdentity\getName(), and NS_USER.
Referenced by MediaWiki\Specials\SpecialBlock\postHtml().
|
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 445 of file SpecialBlock.php.
References MediaWiki\MainConfigNames\EnablePartialActionBlocks, MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\SpecialPage\getName(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\Block\Restriction\PageRestriction\getTitle(), MediaWiki\Block\DatabaseBlock\getType(), MediaWiki\SpecialPage\SpecialPage\getUser(), wfEscapeWikiText(), and wfTimestamp().
Referenced by MediaWiki\Specials\SpecialBlock\getFormFields().
MediaWiki\Specials\SpecialBlock::onSubmit | ( | array | $data, |
HTMLForm | $form = null ) |
Process the form on POST submission.
array | $data | |
HTMLForm | null | $form |
Definition at line 1024 of file SpecialBlock.php.
References getAuthority().
MediaWiki\Specials\SpecialBlock::onSuccess | ( | ) |
Do something exciting on successful processing of the form, most likely to show a confirmation message.
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 1037 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 1000 of file SpecialBlock.php.
References MediaWiki\Block\BlockUser\parseExpiryInput().
|
protected |
Add footer elements to the form.
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 617 of file SpecialBlock.php.
References MediaWiki\SpecialPage\SpecialPage\getAuthority(), MediaWiki\SpecialPage\SpecialPage\getLanguage(), MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\Specials\SpecialBlock\getTargetUserTitle(), getTitle(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), MediaWiki\SpecialPage\SpecialPage\msg(), and wfEscapeWikiText().
MediaWiki\Specials\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 MediaWiki\SpecialPage\SpecialPage.
Definition at line 1051 of file SpecialBlock.php.
|
protected |
Add header elements like block log entries, etc.
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 570 of file SpecialBlock.php.
References MediaWiki\Specials\SpecialBlock\$target, MediaWiki\MainConfigNames\BlockCIDRLimit, MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\User\UserIdentity\getName(), MediaWiki\SpecialPage\SpecialPage\getOutput(), and MediaWiki\SpecialPage\SpecialPage\msg().
|
static |
Given the form data, actually implement a block.
array | $data | |
IContextSource | $context |
Definition at line 796 of file SpecialBlock.php.
References IContextSource\getAuthority(), and MediaWiki\MediaWikiServices\getInstance().
MediaWiki\Specials\SpecialBlock::requiresUnblock | ( | ) |
We allow certain special cases where user is blocked.
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 166 of file SpecialBlock.php.
|
protected |
Handle some magic here.
string | $par |
Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.
Definition at line 175 of file SpecialBlock.php.
References MediaWiki\SpecialPage\FormSpecialPage\$par, MediaWiki\Specials\SpecialBlock\$previousTarget, MediaWiki\Specials\SpecialBlock\$target, MediaWiki\Specials\SpecialBlock\$type, MediaWiki\SpecialPage\SpecialPage\getRequest(), and MediaWiki\SpecialPage\SpecialPage\getSkin().
|
protected |
Definition at line 98 of file SpecialBlock.php.
|
protected |
Definition at line 104 of file SpecialBlock.php.
Referenced by MediaWiki\Specials\SpecialBlock\alterForm().
|
protected |
The previous block target.
Definition at line 92 of file SpecialBlock.php.
Referenced by MediaWiki\Specials\SpecialBlock\setParameter().
|
protected |
Whether the previous submission of the form asked for HideUser.
Definition at line 95 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 86 of file SpecialBlock.php.
Referenced by MediaWiki\Specials\SpecialBlock\getTargetUserTitle(), MediaWiki\Specials\SpecialBlock\preHtml(), and MediaWiki\Specials\SpecialBlock\setParameter().
|
protected |
DatabaseBlock::TYPE_ constant.
Definition at line 89 of file SpecialBlock.php.
Referenced by MediaWiki\Specials\SpecialBlock\setParameter().