ContentModelChange Class Reference

Helper class to change the content model of pages. More...

Collaboration diagram for ContentModelChange:

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

Private Member Functions
	authorizeInternal (callable $authorizer)
	createNewContent ()

Private Attributes
IContentHandlerFactory	$contentHandlerFactory
HookRunner	$hookRunner
int false	$latestRevId
	latest revision id, or false if creating
string	$logAction
	'new' or 'change'
string	$msgPrefix
	'apierror-' or empty string, for status messages
Content	$newContent
string	$newModel
WikiPage	$page
Authority	$performer
	making the change
RevisionLookup	$revLookup
string[]	$tags
	tags to add
UserFactory	$userFactory

Detailed Description

Helper class to change the content model of pages.

For creating new pages via the action API, use the edit api and specify the desired content model and format.

Since

1.35

Author

DannyS712

Definition at line 22 of file ContentModelChange.php.

Constructor & Destructor Documentation

__construct()

ContentModelChange::__construct	(	IContentHandlerFactory	$contentHandlerFactory,
		HookContainer	$hookContainer,
		RevisionLookup	$revLookup,
		UserFactory	$userFactory,
		Authority	$performer,
		WikiPage	$page,
		string	$newModel
	)

Parameters

IContentHandlerFactory	$contentHandlerFactory
HookContainer	$hookContainer
RevisionLookup	$revLookup
UserFactory	$userFactory
Authority	$performer
WikiPage	$page
string	$newModel

Definition at line 69 of file ContentModelChange.php.

Member Function Documentation

authorizeChange()

ContentModelChange::authorizeChange

(

)

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::probablyCanChange instead.

Returns

PermissionStatus

Definition at line 149 of file ContentModelChange.php.

authorizeInternal()

ContentModelChange::authorizeInternal ( callable  $authorizer )

private

Parameters

callable

$authorizer

( string $action, PageIdentity $target, PermissionStatus $status )

Returns

PermissionStatus

Definition at line 110 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 163 of file ContentModelChange.php.

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

createNewContent()

ContentModelChange::createNewContent ( )

private

Returns

Status

Definition at line 191 of file ContentModelChange.php.

References $title, and Message\plaintextParam().

doContentModelChange()

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

Handle change and logging after validation.

Can still be intercepted by hooks

Parameters

IContextSource	$context
string	$comment
bool	$bot	Mark as a bot edit if the user can

Returns

Status

Exceptions

ThrottledError

Definition at line 262 of file ContentModelChange.php.

References $title, EDIT_FORCE_BOT, EDIT_INTERNAL, EDIT_NEW, EDIT_UPDATE, LogFormatter\newFromEntry(), and wfMessage().

probablyCanChange()

ContentModelChange::probablyCanChange

(

)

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::authorizeChange instead.

Returns

PermissionStatus

Definition at line 132 of file ContentModelChange.php.

setMessagePrefix()

ContentModelChange::setMessagePrefix

(

$msgPrefix

)

Parameters

string

$msgPrefix

Definition at line 102 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 178 of file ContentModelChange.php.

References ChangeTags\canAddTagsAccompanyingChange().

Member Data Documentation

$contentHandlerFactory

IContentHandlerFactory ContentModelChange::$contentHandlerFactory

private

Definition at line 25 of file ContentModelChange.php.

$hookRunner

HookRunner ContentModelChange::$hookRunner

private

Definition at line 28 of file ContentModelChange.php.

$latestRevId

int false ContentModelChange::$latestRevId

private

latest revision id, or false if creating

Definition at line 52 of file ContentModelChange.php.

$logAction

string ContentModelChange::$logAction

private

'new' or 'change'

Definition at line 55 of file ContentModelChange.php.

$msgPrefix

string ContentModelChange::$msgPrefix

private

'apierror-' or empty string, for status messages

Definition at line 58 of file ContentModelChange.php.

$newContent

Content ContentModelChange::$newContent

private

Definition at line 49 of file ContentModelChange.php.

$newModel

string ContentModelChange::$newModel

private

Definition at line 43 of file ContentModelChange.php.

$page

WikiPage ContentModelChange::$page

private

Definition at line 40 of file ContentModelChange.php.

$performer

Authority ContentModelChange::$performer

private

making the change

Definition at line 37 of file ContentModelChange.php.

$revLookup

RevisionLookup ContentModelChange::$revLookup

private

Definition at line 31 of file ContentModelChange.php.

$tags

string [] ContentModelChange::$tags

private

tags to add

Definition at line 46 of file ContentModelChange.php.

$userFactory

UserFactory ContentModelChange::$userFactory

private

Definition at line 34 of file ContentModelChange.php.

---

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

• includes/content/ContentModelChange.php