MediaWiki  master
SpecialUnblock Class Reference

A special page for unblocking users. More...

Inheritance diagram for SpecialUnblock:
Collaboration diagram for SpecialUnblock:

Public Member Functions

 __construct ()
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $par)
 Default execute method Checks user permissions. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
- 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...
 
 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...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page Stable to override. 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...
 
 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}} Stable to override. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. 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...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. 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...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 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...
 

Static Public Member Functions

static processUIUnblock (array $data, HTMLForm $form)
 Submit callback for an HTMLForm object. More...
 
static processUnblock (array $data, IContextSource $context)
 Process the form. More...
 
- 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 If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 

Protected Member Functions

 getFields ()
 
 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...
 
- 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...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have Stable to override. More...
 
 getCacheTTL ()
 Stable to override. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. 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...
 
 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...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $block
 
 $target
 
 $type
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Private Member Functions

 getTargetAndType (?string $par, WebRequest $request)
 Get the target and type, given the request and the subpage parameter. More...
 

Additional Inherited Members

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

Detailed Description

A special page for unblocking users.

Definition at line 33 of file SpecialUnblock.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialUnblock::__construct ( )

Definition at line 39 of file SpecialUnblock.php.

Member Function Documentation

◆ doesWrites()

SpecialUnblock::doesWrites ( )

Indicates whether this special page may perform database writes.

Stable to override

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 43 of file SpecialUnblock.php.

◆ execute()

SpecialUnblock::execute (   $subPage)

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stable to override

Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 47 of file SpecialUnblock.php.

References SpecialPage\addHelpLink(), SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), HTMLForm\factory(), SpecialPage\getContext(), getFields(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getSkin(), getTargetAndType(), SpecialPage\msg(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and wfEscapeWikiText().

◆ getFields()

SpecialUnblock::getFields ( )
protected

Definition at line 120 of file SpecialUnblock.php.

References $target, $type, SpecialPage\getLinkRenderer(), and SpecialPage\getTitleFor().

Referenced by execute().

◆ getGroupName()

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

Stable to override

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 260 of file SpecialUnblock.php.

◆ getTargetAndType()

SpecialUnblock::getTargetAndType ( ?string  $par,
WebRequest  $request 
)
private

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.

Parameters
string | null$parSubpage parameter
WebRequest$request
Returns
array [ User|string|null, DatabaseBlock::TYPE_ constant|null ] -return array{0:User|string|null,1:int|null}

Definition at line 102 of file SpecialUnblock.php.

References WebRequest\getVal().

Referenced by execute().

◆ prefixSearchSubpages()

SpecialUnblock::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 250 of file SpecialUnblock.php.

References User\newFromName(), and UserNamePrefixSearch\search().

◆ processUIUnblock()

static SpecialUnblock::processUIUnblock ( array  $data,
HTMLForm  $form 
)
static

Submit callback for an HTMLForm object.

Parameters
array$data
HTMLForm$form

Definition at line 199 of file SpecialUnblock.php.

References ContextSource\getContext().

◆ processUnblock()

static SpecialUnblock::processUnblock ( array  $data,
IContextSource  $context 
)
static

Process the form.

Deprecated:
since 1.36, use UnblockUser instead
Parameters
array$data
IContextSource$context
Returns
array|bool [ [ message key, parameters ] ] on failure, True on success

Definition at line 220 of file SpecialUnblock.php.

References IContextSource\getUser(), and wfDeprecated().

Member Data Documentation

◆ $block

SpecialUnblock::$block
protected

Definition at line 37 of file SpecialUnblock.php.

◆ $target

SpecialUnblock::$target
protected

Definition at line 35 of file SpecialUnblock.php.

Referenced by getFields().

◆ $type

SpecialUnblock::$type
protected

Definition at line 36 of file SpecialUnblock.php.

Referenced by getFields().


The documentation for this class was generated from the following file: