MediaWiki master
ContentModelChange Class Reference

Backend logic for changing the content model of a page. More...

Public Member Functions

 __construct (IContentHandlerFactory $contentHandlerFactory, HookContainer $hookContainer, RevisionLookup $revLookup, UserFactory $userFactory, Authority $performer, WikiPage $page, string $newModel)
 
 authorizeChange ()
 Authorize the content model change by $performer.
 
 checkPermissions ()
 Check user can edit and editcontentmodel before and after.
 
 doContentModelChange (IContextSource $context, string $comment, $bot)
 Handle change and logging after validation.
 
 probablyCanChange ()
 Check whether $performer can execute the content model change.
 
 setMessagePrefix ( $msgPrefix)
 
 setTags ( $tags)
 Specify the tags the user wants to add, and check permissions.
 

Detailed Description

Backend logic for changing the content model of a page.

Note that you can create a new page directly with a desired content model and format, e.g. via EditPage or externally from ApiEditPage.

Since
1.35
Author
DannyS712

Definition at line 26 of file ContentModelChange.php.

Constructor & Destructor Documentation

◆ __construct()

ContentModelChange::__construct ( IContentHandlerFactory  $contentHandlerFactory,
HookContainer  $hookContainer,
RevisionLookup  $revLookup,
UserFactory  $userFactory,
Authority  $performer,
WikiPage  $page,
string  $newModel 
)
Access: internal
Create via the ContentModelChangeFactory service.
Parameters
IContentHandlerFactory$contentHandlerFactory
HookContainer$hookContainer
RevisionLookup$revLookup
UserFactory$userFactory
Authority$performer
WikiPage$page
string$newModel

Definition at line 62 of file ContentModelChange.php.

Member Function Documentation

◆ authorizeChange()

ContentModelChange::authorizeChange ( )

Authorize the content model change by $performer.

Note
this method should be used right before the actual content model change is performed. To check whether a current performer has the potential to change the content model of the page, use self::probablyCanChange instead.
Returns
PermissionStatus

Definition at line 142 of file ContentModelChange.php.

◆ checkPermissions()

ContentModelChange::checkPermissions ( )

Check user can edit and editcontentmodel before and after.

Deprecated:
since 1.36. Use ::probablyCanChange or ::authorizeChange instead.
Returns
array from wfMergeErrorArrays

Definition at line 156 of file ContentModelChange.php.

References MediaWiki\Permissions\PermissionStatus\toLegacyErrorArray(), and wfDeprecated().

◆ doContentModelChange()

ContentModelChange::doContentModelChange ( IContextSource  $context,
string  $comment,
  $bot 
)

Handle change and logging after validation.

Can still be intercepted by hooks

Parameters
IContextSource$context
string$comment
bool$botMark as a bot edit if the user can
Returns
Status

Definition at line 254 of file ContentModelChange.php.

References EDIT_FORCE_BOT, EDIT_INTERNAL, EDIT_NEW, EDIT_UPDATE, and wfMessage().

◆ probablyCanChange()

ContentModelChange::probablyCanChange ( )

Check whether $performer can execute the content model change.

Note
this method does not guarantee full permissions check, so it should only be used to to decide whether to show a content model change form. To authorize the content model change action use self::authorizeChange instead.
Returns
PermissionStatus

Definition at line 125 of file ContentModelChange.php.

◆ setMessagePrefix()

ContentModelChange::setMessagePrefix (   $msgPrefix)
Parameters
string$msgPrefix

Definition at line 95 of file ContentModelChange.php.

◆ setTags()

ContentModelChange::setTags (   $tags)

Specify the tags the user wants to add, and check permissions.

Parameters
string[]$tags
Returns
Status

Definition at line 171 of file ContentModelChange.php.

References ChangeTags\canAddTagsAccompanyingChange().


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