MediaWiki  master
SpecialLockdb Class Reference

A form to make the database readonly (eg for maintenance purposes). More...

Inheritance diagram for SpecialLockdb:
Collaboration diagram for SpecialLockdb:

Public Member Functions

 __construct ()
 
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 onSubmit (array $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 
- Public Member Functions inherited from FormSpecialPage
 execute ( $par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More...
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user. 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...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. 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. 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}}. 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...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 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...
 
 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...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 getDisplayFormat ()
 Get display format for the form. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. 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...
 
- Protected Member Functions inherited from FormSpecialPage
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 postText ()
 Add post-text to the form. More...
 
 preText ()
 Add pre-text to the form. More...
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter. More...
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication. 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...
 
 getCacheTTL ()
 
 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...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $reason = ''
 
- Protected Attributes inherited from FormSpecialPage
string null $par = null
 The sub-page of the special page. More...
 
array null $reauthPostData = null
 POST data preserved across re-authentication. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

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 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...
 
- 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 form to make the database readonly (eg for maintenance purposes).

Definition at line 31 of file SpecialLockdb.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialLockdb::__construct ( )

Definition at line 34 of file SpecialLockdb.php.

Member Function Documentation

◆ alterForm()

SpecialLockdb::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
HTMLForm$form

Reimplemented from FormSpecialPage.

Definition at line 72 of file SpecialLockdb.php.

References SpecialPage\msg(), and HTMLForm\setWrapperLegend().

◆ checkExecutePermissions()

SpecialLockdb::checkExecutePermissions ( User  $user)

Called from execute() to check if the given user can perform this action.

Failures here must throw subclasses of ErrorPageError.

Parameters
User$user
Exceptions
UserBlockedError

Reimplemented from FormSpecialPage.

Definition at line 46 of file SpecialLockdb.php.

References SpecialPage\getConfig().

◆ doesWrites()

SpecialLockdb::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 38 of file SpecialLockdb.php.

◆ getDisplayFormat()

SpecialLockdb::getDisplayFormat ( )
protected

Get display format for the form.

See HTMLForm documentation for available values.

Since
1.25
Returns
string

Reimplemented from FormSpecialPage.

Definition at line 112 of file SpecialLockdb.php.

◆ getFormFields()

SpecialLockdb::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from FormSpecialPage.

Definition at line 57 of file SpecialLockdb.php.

◆ getGroupName()

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

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 116 of file SpecialLockdb.php.

◆ onSubmit()

SpecialLockdb::onSubmit ( array  $data)

Process the form on POST submission.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Parameters
array$data
HTMLForm | null$formPhanCommentParamWithoutRealParam Many implementations don't have $form
Returns
bool|string|array|Status As documented for HTMLForm::trySubmit. @phpcs:enable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Reimplemented from FormSpecialPage.

Definition at line 78 of file SpecialLockdb.php.

References SpecialPage\getConfig(), SpecialPage\getName(), SpecialPage\getUser(), SpecialPage\msg(), StatusValue\newFatal(), StatusValue\newGood(), and wfTimestampNow().

◆ onSuccess()

SpecialLockdb::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since
1.22 Default is to do nothing

Reimplemented from FormSpecialPage.

Definition at line 106 of file SpecialLockdb.php.

References SpecialPage\getOutput(), and SpecialPage\msg().

◆ requiresWrite()

SpecialLockdb::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Returns
bool

Reimplemented from FormSpecialPage.

Definition at line 42 of file SpecialLockdb.php.

Member Data Documentation

◆ $reason

SpecialLockdb::$reason = ''
protected

Definition at line 32 of file SpecialLockdb.php.


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