MediaWiki  master
MovePage Class Reference

Handles the backend logic of moving a page from one title to another. More...

Collaboration diagram for MovePage:

Public Member Functions

 __construct (Title $oldTitle, Title $newTitle, ServiceOptions $options, ILoadBalancer $loadBalancer, NamespaceInfo $nsInfo, WatchedItemStoreInterface $watchedItems, RepoGroup $repoGroup, IContentHandlerFactory $contentHandlerFactory, RevisionStore $revisionStore, SpamChecker $spamChecker, HookContainer $hookContainer, WikiPageFactory $wikiPageFactory, UserFactory $userFactory, UserEditTracker $userEditTracker, MovePageFactory $movePageFactory, CollationFactory $collationFactory, PageUpdaterFactory $pageUpdaterFactory, RestrictionStore $restrictionStore)
 
 authorizeMove (Authority $performer, string $reason=null)
 Authorize the move by $performer. More...
 
 checkPermissions (Authority $performer, $reason)
 Check if the user is allowed to perform the move. More...
 
 isValidMove ()
 Does various checks that the move is valid. More...
 
 move (UserIdentity $user, $reason=null, $createRedirect=true, array $changeTags=[])
 Move a page without taking user permissions into account. More...
 
 moveIfAllowed (Authority $performer, $reason=null, $createRedirect=true, array $changeTags=[])
 Same as move(), but with permissions checks. More...
 
 moveSubpages (UserIdentity $user, $reason=null, $createRedirect=true, array $changeTags=[])
 Move the source page's subpages to be subpages of the target page, without checking user permissions. More...
 
 moveSubpagesIfAllowed (Authority $performer, $reason=null, $createRedirect=true, array $changeTags=[])
 Move the source page's subpages to be subpages of the target page, with user permission checks. More...
 
 probablyCanMove (Authority $performer, string $reason=null)
 Check whether $performer can execute the move. More...
 

Public Attributes

CollationFactory $collationFactory
 
const CONSTRUCTOR_OPTIONS
 

Protected Member Functions

 isValidFileMove ()
 Checks for when a file is being moved. More...
 
 isValidMoveTarget ()
 Checks if $this can be moved to a given Title. More...
 

Protected Attributes

ILoadBalancer $loadBalancer
 
Title $newTitle
 
NamespaceInfo $nsInfo
 
Title $oldTitle
 
ServiceOptions $options
 
RepoGroup $repoGroup
 
WatchedItemStoreInterface $watchedItems
 

Detailed Description

Handles the backend logic of moving a page from one title to another.

Since
1.24

Definition at line 50 of file MovePage.php.

Constructor & Destructor Documentation

◆ __construct()

MovePage::__construct ( Title  $oldTitle,
Title  $newTitle,
ServiceOptions  $options,
ILoadBalancer  $loadBalancer,
NamespaceInfo  $nsInfo,
WatchedItemStoreInterface  $watchedItems,
RepoGroup  $repoGroup,
IContentHandlerFactory  $contentHandlerFactory,
RevisionStore  $revisionStore,
SpamChecker  $spamChecker,
HookContainer  $hookContainer,
WikiPageFactory  $wikiPageFactory,
UserFactory  $userFactory,
UserEditTracker  $userEditTracker,
MovePageFactory  $movePageFactory,
CollationFactory  $collationFactory,
PageUpdaterFactory  $pageUpdaterFactory,
RestrictionStore  $restrictionStore 
)
See also
MovePageFactory
Parameters
Title$oldTitle
Title$newTitle
ServiceOptions$options
ILoadBalancer$loadBalancer
NamespaceInfo$nsInfo
WatchedItemStoreInterface$watchedItems
RepoGroup$repoGroup
IContentHandlerFactory$contentHandlerFactory
RevisionStore$revisionStore
SpamChecker$spamChecker
HookContainer$hookContainer
WikiPageFactory$wikiPageFactory
UserFactory$userFactory
UserEditTracker$userEditTracker
MovePageFactory$movePageFactory
CollationFactory$collationFactory
PageUpdaterFactory$pageUpdaterFactory
RestrictionStore$restrictionStore

Definition at line 162 of file MovePage.php.

References $collationFactory, $loadBalancer, $newTitle, $nsInfo, $oldTitle, $options, $repoGroup, and $watchedItems.

Member Function Documentation

◆ authorizeMove()

MovePage::authorizeMove ( Authority  $performer,
string  $reason = null 
)

Authorize the move by $performer.

Note
this method should be used right before the actual move is performed. To check whether a current performer has the potential to move the page, use self::probablyCanMove instead.
Parameters
Authority$performer
string | null$reason
Returns
PermissionStatus

Definition at line 276 of file MovePage.php.

References MediaWiki\Permissions\Authority\authorizeWrite().

◆ checkPermissions()

MovePage::checkPermissions ( Authority  $performer,
  $reason 
)

Check if the user is allowed to perform the move.

Parameters
Authority$performer
string | null$reasonTo check against summary spam regex. Set to null to skip the check, for instance to display errors preemptively before the user has filled in a summary.
Deprecated:
since 1.36, use ::authorizeMove or ::probablyCanMove instead.
Returns
Status

Definition at line 295 of file MovePage.php.

References MediaWiki\Permissions\Authority\definitelyCan(), and Status\wrap().

◆ isValidFileMove()

MovePage::isValidFileMove ( )
protected

Checks for when a file is being moved.

Returns
Status

Definition at line 393 of file MovePage.php.

References $file, File\checkExtensionCompatibility(), NS_FILE, and wfStripIllegalFilenameChars().

◆ isValidMove()

MovePage::isValidMove ( )

Does various checks that the move is valid.

Only things based on the two titles should be checked here.

Returns
Status

Definition at line 313 of file MovePage.php.

References ContentHandler\getLocalizedName(), NS_FILE, and wfMessage().

◆ isValidMoveTarget()

MovePage::isValidMoveTarget ( )
protected

Checks if $this can be moved to a given Title.

  • Selects for update, so don't call it unless you mean business
Since
1.25
Returns
bool

Definition at line 422 of file MovePage.php.

References $content, $file, NS_FILE, and wfDebug().

◆ move()

MovePage::move ( UserIdentity  $user,
  $reason = null,
  $createRedirect = true,
array  $changeTags = [] 
)

Move a page without taking user permissions into account.

Only checks if the move is itself invalid, e.g., trying to move a special page or trying to move a page onto one that already exists.

Parameters
UserIdentity$user
string | null$reason
bool | null$createRedirect
string[]$changeTagsChange tags to apply to the entry in the move log
Returns
Status

Definition at line 478 of file MovePage.php.

◆ moveIfAllowed()

MovePage::moveIfAllowed ( Authority  $performer,
  $reason = null,
  $createRedirect = true,
array  $changeTags = [] 
)

Same as move(), but with permissions checks.

Parameters
Authority$performer
string | null$reason
bool$createRedirectIgnored if user doesn't have suppressredirect permission
string[]$changeTagsChange tags to apply to the entry in the move log
Returns
Status

Definition at line 498 of file MovePage.php.

References ChangeTags\canAddTagsAccompanyingChange(), MediaWiki\Permissions\Authority\getUser(), and MediaWiki\Permissions\Authority\isAllowed().

◆ moveSubpages()

MovePage::moveSubpages ( UserIdentity  $user,
  $reason = null,
  $createRedirect = true,
array  $changeTags = [] 
)

Move the source page's subpages to be subpages of the target page, without checking user permissions.

The caller is responsible for moving the source page itself. We will still not do moves that are inherently not allowed, nor will we move more than $wgMaximumMovedPages.

Parameters
UserIdentity$user
string | null$reasonThe reason for the move
bool | null$createRedirectWhether to create redirects from the old subpages to the new ones
string[]$changeTagsApplied to entries in the move log and redirect page revision
Returns
Status Good if no errors occurred. Ok if at least one page succeeded. The "value" of the top-level status is an array containing the per-title status for each page. For any move that succeeded, the "value" of the per-title status is the new page title.

Definition at line 537 of file MovePage.php.

◆ moveSubpagesIfAllowed()

MovePage::moveSubpagesIfAllowed ( Authority  $performer,
  $reason = null,
  $createRedirect = true,
array  $changeTags = [] 
)

Move the source page's subpages to be subpages of the target page, with user permission checks.

The caller is responsible for moving the source page itself.

Parameters
Authority$performer
string | null$reasonThe reason for the move
bool | null$createRedirectWhether to create redirects from the old subpages to the new ones. Ignored if the user doesn't have the 'suppressredirect' right.
string[]$changeTagsApplied to entries in the move log and redirect page revision
Returns
Status Good if no errors occurred. Ok if at least one page succeeded. The "value" of the top-level status is an array containing the per-title status for each page. For any move that succeeded, the "value" of the per-title status is the new page title.

Definition at line 562 of file MovePage.php.

References MediaWiki\Permissions\Authority\authorizeWrite(), and StatusValue\newFatal().

◆ probablyCanMove()

MovePage::probablyCanMove ( Authority  $performer,
string  $reason = null 
)

Check whether $performer can execute the move.

Note
this method does not guarantee full permissions check, so it should only be used to to decide whether to show a move form. To authorize the move action use self::authorizeMove instead.
Parameters
Authority$performer
string | null$reason
Returns
PermissionStatus

Definition at line 255 of file MovePage.php.

References MediaWiki\Permissions\Authority\probablyCan().

Member Data Documentation

◆ $collationFactory

CollationFactory MovePage::$collationFactory

Definition at line 124 of file MovePage.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer MovePage::$loadBalancer
protected

Definition at line 70 of file MovePage.php.

Referenced by __construct().

◆ $newTitle

Title MovePage::$newTitle
protected

Definition at line 60 of file MovePage.php.

Referenced by __construct().

◆ $nsInfo

NamespaceInfo MovePage::$nsInfo
protected

Definition at line 75 of file MovePage.php.

Referenced by __construct().

◆ $oldTitle

Title MovePage::$oldTitle
protected

Definition at line 55 of file MovePage.php.

Referenced by __construct().

◆ $options

ServiceOptions MovePage::$options
protected

Definition at line 65 of file MovePage.php.

Referenced by __construct().

◆ $repoGroup

RepoGroup MovePage::$repoGroup
protected

Definition at line 85 of file MovePage.php.

Referenced by __construct().

◆ $watchedItems

WatchedItemStoreInterface MovePage::$watchedItems
protected

Definition at line 80 of file MovePage.php.

Referenced by __construct().

◆ CONSTRUCTOR_OPTIONS

const MovePage::CONSTRUCTOR_OPTIONS
Initial value:
= [
MainConfigNames::CategoryCollation,
MainConfigNames::MaximumMovedPages,
]
Access: internal
For use by PageCommandFactory

Definition at line 135 of file MovePage.php.


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