MediaWiki  master
MovePageForm Class Reference

A special page that allows users to change page titles. More...

Inheritance diagram for MovePageForm:
Collaboration diagram for MovePageForm:

Public Member Functions

 __construct (MovePageFactory $movePageFactory, PermissionManager $permManager, UserOptionsLookup $userOptionsLookup, ILoadBalancer $loadBalancer, IContentHandlerFactory $contentHandlerFactory, NamespaceInfo $nsInfo, LinkBatchFactory $linkBatchFactory, RepoGroup $repoGroup, WikiPageFactory $wikiPageFactory, SearchEngineFactory $searchEngineFactory, WatchlistManager $watchlistManager)
 
 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 UnlistedSpecialPage
 __construct ( $name, $restriction='', $function=false, $file='default')
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. 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...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. 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...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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

 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...
 
 showForm ( $err, $isPermError=false)
 Show the form. 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. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 
 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...
 
 getSpecialPageFactory ()
 
 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, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

bool $deleteAndMove
 
bool $fixRedirects
 
bool $leaveRedirect
 
bool $moveOverShared
 
bool $moveSubpages
 
bool $moveTalk
 
Title $newTitle
 
Title $oldTitle = null
 
string $reason
 Text input. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Private Member Functions

 doSubmit ()
 
 showLogFragment ( $title)
 
 showSubpages ( $title)
 Show subpages of the page being moved. More...
 
 showSubpagesList ( $subpages, $pagecount, $wikiMsg, $noSubpageMsg=false)
 

Private Attributes

IContentHandlerFactory $contentHandlerFactory
 
LinkBatchFactory $linkBatchFactory
 
ILoadBalancer $loadBalancer
 
MovePageFactory $movePageFactory
 
NamespaceInfo $nsInfo
 
PermissionManager $permManager
 
RepoGroup $repoGroup
 
SearchEngineFactory $searchEngineFactory
 
UserOptionsLookup $userOptionsLookup
 
 $watch = false
 
WatchlistManager $watchlistManager
 
WikiPageFactory $wikiPageFactory
 

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 special page that allows users to change page titles.

Definition at line 38 of file SpecialMovepage.php.

Constructor & Destructor Documentation

◆ __construct()

MovePageForm::__construct ( MovePageFactory  $movePageFactory,
PermissionManager  $permManager,
UserOptionsLookup  $userOptionsLookup,
ILoadBalancer  $loadBalancer,
IContentHandlerFactory  $contentHandlerFactory,
NamespaceInfo  $nsInfo,
LinkBatchFactory  $linkBatchFactory,
RepoGroup  $repoGroup,
WikiPageFactory  $wikiPageFactory,
SearchEngineFactory  $searchEngineFactory,
WatchlistManager  $watchlistManager 
)
Parameters
MovePageFactory$movePageFactory
PermissionManager$permManager
UserOptionsLookup$userOptionsLookup
ILoadBalancer$loadBalancer
IContentHandlerFactory$contentHandlerFactory
NamespaceInfo$nsInfo
LinkBatchFactory$linkBatchFactory
RepoGroup$repoGroup
WikiPageFactory$wikiPageFactory
SearchEngineFactory$searchEngineFactory
WatchlistManager$watchlistManager

Definition at line 116 of file SpecialMovepage.php.

References $contentHandlerFactory, $linkBatchFactory, $loadBalancer, $movePageFactory, $nsInfo, $permManager, $repoGroup, $searchEngineFactory, $userOptionsLookup, $watchlistManager, and $wikiPageFactory.

Member Function Documentation

◆ doesWrites()

MovePageForm::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable
to override
Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 143 of file SpecialMovepage.php.

◆ doSubmit()

◆ execute()

MovePageForm::execute (   $subPage)

Default execute method Checks user permissions.

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

Stability: stable
to override
Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 147 of file SpecialMovepage.php.

References DeferredUpdates\addCallableUpdate(), SpecialPage\checkReadOnly(), doSubmit(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), Title\makeTitleSafe(), Title\newFromText(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showForm(), and SpecialPage\useTransactionalTimeLimit().

◆ getGroupName()

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

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 983 of file SpecialMovepage.php.

◆ prefixSearchSubpages()

MovePageForm::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 979 of file SpecialMovepage.php.

References SpecialPage\prefixSearchString().

◆ showForm()

MovePageForm::showForm (   $err,
  $isPermError = false 
)
protected

Show the form.

Parameters
(string|array)[]$err Error messages. Each item is an error message. It may either be a string message name or array message name and parameters, like the second argument to OutputPage::wrapWikiMsg().
bool$isPermErrorWhether the error message is about user permissions.

Definition at line 221 of file SpecialMovepage.php.

References $dbr, $deleteAndMove, $leaveRedirect, $moveOverShared, $newTitle, $oldTitle, SpecialPage\addHelpLink(), CommentStore\COMMENT_CHARACTER_LIMIT, DB_REPLICA, Html\errorBox(), SpecialPage\getConfig(), SpecialPage\getLanguage(), Title\getNamespace(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Title\getPrefixedText(), SpecialPage\getSkin(), Title\getText(), SpecialPage\getUser(), Html\hidden(), SpecialPage\msg(), NS_CATEGORY, NS_USER, LogEventsList\showLogExtract(), showLogFragment(), and showSubpages().

Referenced by doSubmit(), and execute().

◆ showLogFragment()

MovePageForm::showLogFragment (   $title)
private

Definition at line 906 of file SpecialMovepage.php.

References $title, Xml\element(), SpecialPage\getOutput(), and LogEventsList\showLogExtract().

Referenced by showForm().

◆ showSubpages()

MovePageForm::showSubpages (   $title)
private

Show subpages of the page being moved.

Section is not shown if both current namespace does not support subpages and no talk subpages were found.

Parameters
Title$titlePage being moved.

Definition at line 919 of file SpecialMovepage.php.

References $title, SpecialPage\getOutput(), and showSubpagesList().

Referenced by showForm().

◆ showSubpagesList()

MovePageForm::showSubpagesList (   $subpages,
  $pagecount,
  $wikiMsg,
  $noSubpageMsg = false 
)
private

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory MovePageForm::$contentHandlerFactory
private

Definition at line 83 of file SpecialMovepage.php.

Referenced by __construct().

◆ $deleteAndMove

bool MovePageForm::$deleteAndMove
protected

Definition at line 54 of file SpecialMovepage.php.

Referenced by showForm().

◆ $fixRedirects

bool MovePageForm::$fixRedirects
protected

Definition at line 60 of file SpecialMovepage.php.

◆ $leaveRedirect

bool MovePageForm::$leaveRedirect
protected

Definition at line 63 of file SpecialMovepage.php.

Referenced by doSubmit(), and showForm().

◆ $linkBatchFactory

LinkBatchFactory MovePageForm::$linkBatchFactory
private

Definition at line 89 of file SpecialMovepage.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer MovePageForm::$loadBalancer
private

Definition at line 80 of file SpecialMovepage.php.

Referenced by __construct().

◆ $moveOverShared

bool MovePageForm::$moveOverShared
protected

Definition at line 66 of file SpecialMovepage.php.

Referenced by showForm().

◆ $movePageFactory

MovePageFactory MovePageForm::$movePageFactory
private

Definition at line 71 of file SpecialMovepage.php.

Referenced by __construct().

◆ $moveSubpages

bool MovePageForm::$moveSubpages
protected

Definition at line 57 of file SpecialMovepage.php.

◆ $moveTalk

bool MovePageForm::$moveTalk
protected

Definition at line 51 of file SpecialMovepage.php.

◆ $newTitle

Title MovePageForm::$newTitle
protected

Definition at line 43 of file SpecialMovepage.php.

Referenced by doSubmit(), and showForm().

◆ $nsInfo

NamespaceInfo MovePageForm::$nsInfo
private

Definition at line 86 of file SpecialMovepage.php.

Referenced by __construct().

◆ $oldTitle

Title MovePageForm::$oldTitle = null
protected

Definition at line 40 of file SpecialMovepage.php.

Referenced by doSubmit(), and showForm().

◆ $permManager

PermissionManager MovePageForm::$permManager
private

Definition at line 74 of file SpecialMovepage.php.

Referenced by __construct().

◆ $reason

string MovePageForm::$reason
protected

Text input.

Definition at line 46 of file SpecialMovepage.php.

Referenced by doSubmit().

◆ $repoGroup

RepoGroup MovePageForm::$repoGroup
private

Definition at line 92 of file SpecialMovepage.php.

Referenced by __construct().

◆ $searchEngineFactory

SearchEngineFactory MovePageForm::$searchEngineFactory
private

Definition at line 98 of file SpecialMovepage.php.

Referenced by __construct().

◆ $userOptionsLookup

UserOptionsLookup MovePageForm::$userOptionsLookup
private

Definition at line 77 of file SpecialMovepage.php.

Referenced by __construct().

◆ $watch

MovePageForm::$watch = false
private

Definition at line 68 of file SpecialMovepage.php.

◆ $watchlistManager

WatchlistManager MovePageForm::$watchlistManager
private

Definition at line 101 of file SpecialMovepage.php.

Referenced by __construct().

◆ $wikiPageFactory

WikiPageFactory MovePageForm::$wikiPageFactory
private

Definition at line 95 of file SpecialMovepage.php.

Referenced by __construct().


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