A content handler knows how do deal with a specific type of content on a wiki page. More...

Inheritance diagram for ContentHandler:

[legend]

Collaboration diagram for ContentHandler:

Public Member Functions
	__construct ( $modelId, $formats)
	Constructor, initializing the ContentHandler instance with its model ID and a list of supported formats.

	canBeUsedOn (Title $title)
	Determines whether the content type handled by this ContentHandler can be used for the main slot of the given page.

	createDifferenceEngine (IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
	Factory for creating an appropriate DifferenceEngine for this content model.

	exportTransform ( $blob, $format=null)
	Applies transformations on export (returns the blob unchanged per default).

	getActionOverrides ()
	Returns overrides for action handlers.

	getAutoDeleteReason (Title $title, &$hasHistory)
	Auto-generates a deletion reason.

	getAutosummary (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return an applicable auto-summary if one exists for the given edit.

	getChangeTag (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return an applicable tag if one exists for the given edit or return null.

	getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine)
	Return fields to be indexed by search engine as representation of this document.

	getDefaultFormat ()
	The format used for serialization/deserialization by default by this ContentHandler.

	getDeletionUpdates (Title $title, $role)
	Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store.

	getFieldsForSearchIndex (SearchEngine $engine)
	Get fields definition for search index.

	getModelID ()
	Returns the model id that identifies the content model this ContentHandler can handle.

	getPageLanguage (Title $title, Content $content=null)
	Get the language in which the content of the given page is written.

	getPageViewLanguage (Title $title, Content $content=null)
	Get the language in which the content of this page is written when viewed by user.

	getParserOutputForIndexing (WikiPage $page, ParserCache $cache=null)
	Produce page output suitable for indexing.

	getSecondaryDataUpdates (Title $title, Content $content, $role, SlotRenderingProvider $slotOutput)
	Returns a list of DeferrableUpdate objects for recording information about the given Content in some secondary data store.

	getSlotDiffRenderer (IContextSource $context)
	Get an appropriate SlotDiffRenderer for this content model.

	getSupportedFormats ()
	Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler.

	getUndoContent ( $current, $undo, $undoafter, $undoIsLatest=false)
	Get the Content object that needs to be saved in order to undo all revisions between $undo and $undoafter.

	importTransform ( $blob, $format=null)
	Apply import transformation (per default, returns $blob unchanged).

	isParserCacheSupported ()
	Returns true for content models that support caching using the ParserCache mechanism.

	isSupportedFormat ( $format)
	Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise.

	makeEmptyContent ()
	Creates an empty Content object of the type supported by this ContentHandler.

	makeParserOptions ( $context)
	Get parser options suitable for rendering and caching the article.

	makeRedirectContent (Title $destination, $text='')
	Creates a new Content object that acts as a redirect to the given page, or null if redirects are not supported by this content model.

	merge3 (Content $oldContent, Content $myContent, Content $yourContent)
	Attempts to merge differences between three versions.

	serializeContent (Content $content, $format=null)
	Serializes a Content object of the type supported by this ContentHandler.

	supportsCategories ()
	Returns true if this content model supports categories.

	supportsDirectApiEditing ()
	Whether or not this content model supports direct editing via ApiEditPage.

	supportsDirectEditing ()
	Return true if this content model supports direct editing, such as via EditPage.

	supportsRedirects ()
	Returns true if this content model supports redirects.

	supportsSections ()
	Returns true if this content model supports sections.

	unserializeContent ( $blob, $format=null)
	Unserializes a Content object of the type supported by this ContentHandler.

Static Public Member Functions
static	cleanupHandlersCache ()
	Clean up handlers cache.

static	getAllContentFormats ()

static	getContentModels ()

static	getContentText (Content $content=null)
	Convenience function for getting flat text from a Content object.

static	getDefaultModelFor (Title $title)
	Returns the name of the default content model to be used for the page with the given title.

static	getForContent (Content $content)
	Returns the appropriate ContentHandler singleton for the given Content object.

static	getForModelID ( $modelId)
	Returns the ContentHandler singleton for the given model ID.

static	getForTitle (Title $title)
	Returns the appropriate ContentHandler singleton for the given title.

static	getLocalizedName ( $name, Language $lang=null)
	Returns the localized name for a given content model.

static	makeContent ( $text, Title $title=null, $modelId=null, $format=null)
	Convenience function for creating a Content object from a given textual representation.

Protected Member Functions
	addSearchField (&$fields, SearchEngine $engine, $name, $type)
	Add new field definition to array.

	checkFormat ( $format)
	Convenient for checking whether a format provided as a parameter is actually supported.

	checkModelID ( $model_id)

	getDiffEngineClass ()
	Returns the name of the diff engine to use.

	getSlotDiffRendererInternal (IContextSource $context)
	Return the SlotDiffRenderer appropriate for this content handler.

Protected Attributes
string	$mModelID

string[]	$mSupportedFormats

Static Protected Attributes
static array	$handlers
	A Cache of ContentHandler instances by model id.

Private Member Functions
	getChangeType (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return type of change if one exists for the given edit.

Detailed Description

A content handler knows how do deal with a specific type of content on a wiki page.

Content is stored in the database in a serialized form (using a serialization format a.k.a. MIME type) and is unserialized into its native PHP representation (the content model), which is wrapped in an instance of the appropriate subclass of Content.

ContentHandler instances are stateless singletons that serve, among other things, as a factory for Content objects. Generally, there is one subclass of ContentHandler and one subclass of Content for every type of content model.

Some content types have a flat model, that is, their native representation is the same as their serialized form. Examples would be JavaScript and CSS code. As of now, this also applies to wikitext (MediaWiki's default content type), but wikitext content may be represented by a DOM or AST structure in the future.

Definition at line 53 of file ContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ContentHandler::__construct	(	$modelId,
		$formats
	)

Constructor, initializing the ContentHandler instance with its model ID and a list of supported formats.

Values for the parameters are typically provided as literals by subclass's constructors.

Parameters

string	$modelId	(use CONTENT_MODEL_XXX constants).
string[]	$formats	List for supported serialization formats (typically as MIME types)

Reimplemented in DummyContentHandlerForTesting, and TextContentHandler.

Definition at line 371 of file ContentHandler.php.

Member Function Documentation

◆ addSearchField()

ContentHandler::addSearchField	(	&	$fields,
		SearchEngine	$engine,
			$name,
			$type
	)

protected

Add new field definition to array.

Parameters

SearchIndexField[]	&$fields
SearchEngine	$engine
string	$name
int	$type

Returns: SearchIndexField[] new field defs

Since: 1.28

Definition at line 1296 of file ContentHandler.php.

References $engine, $name, and $type.

◆ canBeUsedOn()

ContentHandler::canBeUsedOn ( Title $title )

Determines whether the content type handled by this ContentHandler can be used for the main slot of the given page.

This default implementation always returns true. Subclasses may override this to restrict the use of this content model to specific locations, typically based on the namespace or some other aspect of the title, such as a special suffix (e.g. ".svg" for SVG content).

Note: this calls the ContentHandlerCanBeUsedOn hook which may be used to override which content model can be used where.

See also: SlotRoleHandler::isAllowedModel

Parameters

Title $title The page's title.

Returns: bool True if content of this kind can be used on the given page, false otherwise.

Definition at line 751 of file ContentHandler.php.

References $title, and getModelID().

◆ checkFormat()

ContentHandler::checkFormat ( $format )

protected

Convenient for checking whether a format provided as a parameter is actually supported.

Parameters

string $format The serialization format to check

Exceptions

MWException If the format is not supported by this content handler.

Definition at line 544 of file ContentHandler.php.

References getModelID(), and isSupportedFormat().

Referenced by TextContentHandler\serializeContent(), WikitextContentHandler\serializeContent(), TextContentHandler\unserializeContent(), and RevisionTestModifyableContentHandler\unserializeContent().

◆ checkModelID()

ContentHandler::checkModelID ( $model_id )

protected

Since: 1.21

Parameters

string $model_id The model to check

Exceptions

MWException If the model ID is not the ID of the content model supported by this ContentHandler.

Definition at line 480 of file ContentHandler.php.

Referenced by getAutoDeleteReason(), getUndoContent(), and TextContentHandler\merge3().

◆ cleanupHandlersCache()

static ContentHandler::cleanupHandlersCache ( )

static

Clean up handlers cache.

Definition at line 297 of file ContentHandler.php.

◆ createDifferenceEngine()

ContentHandler::createDifferenceEngine	(	IContextSource	$context,
			$old = `0`,
			$new = `0`,
			$rcid = `0`,
			$refreshCache = `false`,
			$unhide = `false`
	)

Factory for creating an appropriate DifferenceEngine for this content model.

Since 1.32, this is only used for page-level diffs; to diff two content objects, use getSlotDiffRenderer.

The DifferenceEngine subclass to use is selected in getDiffEngineClass(). The GetDifferenceEngine hook will receive the DifferenceEngine object and can replace or wrap it. (Note that in older versions of MediaWiki the hook documentation instructed extensions to return false from the hook; you should not rely on always being able to decorate the DifferenceEngine instance from the hook. If the owner of the content type wants to decorare the instance, overriding this method is a safer approach.)

Todo:: This is page-level functionality so it should not belong to ContentHandler. Move it to a better place once one exists (e.g. PageTypeHandler).

Since: 1.21

Parameters

IContextSource	$context	Context to use, anything else will be ignored.
int	$old	Revision ID we want to show and diff with.
int \| string	$new	Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
int	$rcid	FIXME: Deprecated, no longer used. Defaults to 0.
bool	$refreshCache	If set, refreshes the diff cache. Defaults to false.
bool	$unhide	If set, allow viewing deleted revs. Defaults to false.

Returns: DifferenceEngine

Definition at line 599 of file ContentHandler.php.

References $context, $differenceEngine, $refreshCache, $unhide, and getDiffEngineClass().

Referenced by getSlotDiffRenderer().

◆ exportTransform()

ContentHandler::exportTransform	(	$blob,
		$format = `null`
	)

Applies transformations on export (returns the blob unchanged per default).

Subclasses may override this to perform transformations such as conversion of legacy formats or filtering of internal meta-data.

Parameters

string	$blob	The blob to be exported
string \| null	$format	The blob's serialization format

Returns: string

Reimplemented in MediaWiki\Tests\Maintenance\BackupTextPassTestModelHandler.

Definition at line 398 of file ContentHandler.php.

References $blob.

◆ getActionOverrides()

ContentHandler::getActionOverrides ( )

Returns overrides for action handlers.

Classes listed here will be used instead of the default one when (and only when) $wgActions[$action] === true. This allows subclasses to override the default action handlers.

Since: 1.21

Returns: array An array mapping action names (typically "view", "edit", "history" etc.) to either the full qualified class name of an Action class, a callable taking ( Page $page, IContextSource $context = null ) as parameters and returning an Action object, or an actual Action object. An empty array in this default implementation.

See also: Action::factory

Definition at line 568 of file ContentHandler.php.

◆ getAllContentFormats()

static ContentHandler::getAllContentFormats ( )

static

Definition at line 335 of file ContentHandler.php.

References $handler, $wgContentHandlers, and as.

◆ getAutoDeleteReason()

ContentHandler::getAutoDeleteReason	(	Title	$title,
		&	$hasHistory
	)

Auto-generates a deletion reason.

Since: 1.21

Parameters

Title	$title	The page's title
bool	&$hasHistory	Whether the page has a history

Returns: mixed String containing deletion reason or empty string, or boolean false if no revision occurred

Todo:: &$hasHistory is extremely ugly, it's here because WikiPage::getAutoDeleteReason() and Article::generateReason() have it / want it.

Definition at line 989 of file ContentHandler.php.

References $content, $dbr, $res, $rev, $revQuery, $title, as, checkModelID(), DB_REPLICA, Revision\DELETED_USER, Revision\getQueryInfo(), Revision\newFromTitle(), wfGetDB(), and wfMessage().

◆ getAutosummary()

ContentHandler::getAutosummary	(	Content	$oldContent = `null`,
		Content	$newContent = `null`,
			$flags = `0`
	)

Return an applicable auto-summary if one exists for the given edit.

Since: 1.21

Parameters

Content \| null	$oldContent	The previous text of the page.
Content \| null	$newContent	The submitted text of the page.
int	$flags	Bit mask: a bit mask of flags submitted for the edit.

Returns: string An appropriate auto-summary, or an empty string.

Definition at line 866 of file ContentHandler.php.

References getChangeType(), text, and wfMessage().

◆ getChangeTag()

ContentHandler::getChangeTag	(	Content	$oldContent = `null`,
		Content	$newContent = `null`,
			$flags = `0`
	)

Return an applicable tag if one exists for the given edit or return null.

Since: 1.31

Parameters

Content \| null	$oldContent	The previous text of the page.
Content \| null	$newContent	The submitted text of the page.
int	$flags	Bit mask: a bit mask of flags submitted for the edit.

Returns: string|null An appropriate tag, or null.

Definition at line 949 of file ContentHandler.php.

References getChangeType(), and ChangeTags\getSoftwareTags().

◆ getChangeType()

ContentHandler::getChangeType	(	Content	$oldContent = `null`,
		Content	$newContent = `null`,
			$flags = `0`
	)

private

Return type of change if one exists for the given edit.

Since: 1.31

Parameters

Content \| null	$oldContent	The previous text of the page.
Content \| null	$newContent	The submitted text of the page.
int	$flags	Bit mask: a bit mask of flags submitted for the edit.

Returns: string|null String key representing type of change, or null.

Definition at line 799 of file ContentHandler.php.

References EDIT_NEW.

Referenced by getAutosummary(), and getChangeTag().

◆ getContentModels()

static ContentHandler::getContentModels ( )

static

Definition at line 327 of file ContentHandler.php.

References $wgContentHandlers.

◆ getContentText()

static ContentHandler::getContentText ( Content $content = null )

static

Convenience function for getting flat text from a Content object.

This should only be used in the context of backwards compatibility with code that is not yet able to handle Content objects!

If $content is null, this method returns the empty string.

If $content is an instance of TextContent, this method returns the flat text as returned by $content->getText().

If $content is not a TextContent object, the behavior of this method depends on the global $wgContentHandlerTextFallback:

If $wgContentHandlerTextFallback is 'fail' and $content is not a TextContent object, an MWException is thrown.
If $wgContentHandlerTextFallback is 'serialize' and $content is not a TextContent object, $content->serialize() is called to get a string form of the content.
If $wgContentHandlerTextFallback is 'ignore' and $content is not a TextContent object, this method returns null.
otherwise, the behavior is undefined.

Since: 1.21

Parameters

Content | null $content

Exceptions

MWException If the content is not an instance of TextContent and wgContentHandlerTextFallback was set to 'fail'.

Returns: string|null Textual form of the content, if available.

Definition at line 83 of file ContentHandler.php.

References $content, $wgContentHandlerTextFallback, and wfDebugLog().

◆ getDataForSearchIndex()

ContentHandler::getDataForSearchIndex	(	WikiPage	$page,
		ParserOutput	$output,
		SearchEngine	$engine
	)

Return fields to be indexed by search engine as representation of this document.

Overriding class should call parent function or take care of calling the SearchDataForIndex hook.

Parameters

WikiPage	$page	Page to index
ParserOutput	$output
SearchEngine	$engine	Search engine for which we are indexing

Returns: array Map of name=>value for fields

Since: 1.28

Reimplemented in TextContentHandler, FileContentHandler, and WikitextContentHandler.

Definition at line 1312 of file ContentHandler.php.

References $content, $engine, $output, and WikiPage\getContent().

Referenced by WikitextContentHandlerTest\testDataIndexFieldsFile().

◆ getDefaultFormat()

ContentHandler::getDefaultFormat ( )

The format used for serialization/deserialization by default by this ContentHandler.

This default implementation will return the first element of the array of formats that was passed to the constructor.

Since: 1.21

Returns: string The name of the default serialization format as a MIME type

Definition at line 512 of file ContentHandler.php.

Referenced by TextContentHandler\merge3().

◆ getDefaultModelFor()

static ContentHandler::getDefaultModelFor ( Title $title )

static

Returns the name of the default content model to be used for the page with the given title.

Note: There should rarely be need to call this method directly. To determine the actual content model for a given page, use Title::getContentModel().

Which model is to be used by default for the page is determined based on several factors:

The global setting $wgNamespaceContentModels specifies a content model per namespace.
The hook ContentHandlerDefaultModelFor may be used to override the page's default model.
Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript model if they end in .js or .css, respectively.
Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
The hook TitleIsCssOrJsPage may be used to force a page to use the CSS or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor hook should be used instead if possible.
The hook TitleIsWikitextPage may be used to force a page to use the wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor hook should be used instead if possible.

If none of the above applies, the wikitext model is used.

Note: this is used by, and may thus not use, Title::getContentModel()

Since: 1.21

Deprecated:: since 1.33, use SlotRoleHandler::getDefaultModel() together with SlotRoleRegistry::getRoleHandler().

Parameters

Title $title

Returns: string Default model name for the page given by $title

Definition at line 184 of file ContentHandler.php.

References $title.

◆ getDeletionUpdates()

ContentHandler::getDeletionUpdates	(	Title	$title,
			$role
	)

Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store.

This is used when a page is deleted, and also when a slot is removed from a page.

Application logic should not call this method directly. Instead, it should call WikiPage::getSecondaryDataUpdates().

Note: Implementations must not return a LinksDeletionUpdate instance. Instead, a LinksDeletionUpdate is created by the calling code in WikiPage. This is in contrast to the old getDeletionUpdates method defined by AbstractContent, which returned a LinksUpdate.; Implementations should not rely on the page's current content, but rather the current state of the secondary data store.

Parameters

Title	$title	The title of the page to supply the updates for
string	$role	The role (slot) in which the content is being used. Which updates are performed should generally not depend on the role the content has, but the DeferrableUpdates themselves may need to know the role, to track to which slot the data refers, and to avoid overwriting data of the same kind from another slot.

Returns: DeferrableUpdate[] A list of DeferrableUpdate objects for putting information about this content object somewhere. The default implementation returns an empty array.

Since: 1.32

Definition at line 1438 of file ContentHandler.php.

Referenced by WikitextContentHandlerTest\testGetDeletionUpdates().

◆ getDiffEngineClass()

ContentHandler::getDiffEngineClass ( )

protected

Returns the name of the diff engine to use.

Since: 1.21

Returns: string

Definition at line 766 of file ContentHandler.php.

Referenced by createDifferenceEngine().

◆ getFieldsForSearchIndex()

ContentHandler::getFieldsForSearchIndex ( SearchEngine $engine )

Get fields definition for search index.

Todo:: Expose title, redirect, namespace, text, source_text, text_bytes field mappings here. (see T142670 and T143409)

Parameters

SearchEngine $engine

Returns: SearchIndexField[] List of fields this content handler can provide.

Since: 1.28

Reimplemented in FileContentHandler, TextContentHandler, and WikitextContentHandler.

Definition at line 1256 of file ContentHandler.php.

References $engine, SearchIndexField\FLAG_CASEFOLD, SearchIndexField\INDEX_TYPE_KEYWORD, and SearchIndexField\INDEX_TYPE_TEXT.

◆ getForContent()

static ContentHandler::getForContent ( Content $content )

static

Returns the appropriate ContentHandler singleton for the given Content object.

Since: 1.21

Parameters

Content $content

Returns: ContentHandler

Definition at line 215 of file ContentHandler.php.

References $content.

◆ getForModelID()

static ContentHandler::getForModelID ( $modelId )

static

Returns the ContentHandler singleton for the given model ID.

Use the CONTENT_MODEL_XXX constants to identify the desired content model.

ContentHandler singletons are taken from the global $wgContentHandlers array. Keys in that array are model names, the values are either ContentHandler singleton objects, or strings specifying the appropriate subclass of ContentHandler.

If a class name is encountered when looking up the singleton for a given model name, the class is instantiated and the class name is replaced by the resulting singleton in $wgContentHandlers.

If no ContentHandler is defined for the desired $modelId, the ContentHandler may be provided by the ContentHandlerForModelID hook. If no ContentHandler can be determined, an MWException is raised.

Since: 1.21

Parameters

string $modelId The ID of the content model for which to get a handler. Use CONTENT_MODEL_XXX constants.

Exceptions

MWException	For internal errors and problems in the configuration.
MWUnknownContentModelException	If no handler is known for the model ID.

Returns: ContentHandler The ContentHandler singleton for handling the model given by the ID.

Definition at line 252 of file ContentHandler.php.

References $handler, $wgContentHandlers, and wfDebugLog().

Referenced by MediaWiki\EditPage\TextConflictHelper\__construct(), and MediaWiki\EditPage\TextConflictHelper\showEditFormTextAfterFooters().

◆ getForTitle()

static ContentHandler::getForTitle ( Title $title )

static

Returns the appropriate ContentHandler singleton for the given title.

Since: 1.21

Parameters

Title $title

Returns: ContentHandler

Definition at line 199 of file ContentHandler.php.

References $title.

◆ getLocalizedName()

static ContentHandler::getLocalizedName	(		$name,
		Language	$lang = `null`
	)

static

Returns the localized name for a given content model.

Model names are localized using system messages. Message keys have the form content-model-$name, where $name is getContentModelName( $id ).

Parameters

string	$name	The content model ID, as given by a CONTENT_MODEL_XXX constant or returned by Revision::getContentModel().
Language \| null	$lang	The language to parse the message in (since 1.26)

Exceptions

MWException If the model ID isn't known.

Returns: string The content model's localized name.

Definition at line 314 of file ContentHandler.php.

References $lang, $name, and wfMessage().

◆ getModelID()

ContentHandler::getModelID ( )

Returns the model id that identifies the content model this ContentHandler can handle.

Use with the CONTENT_MODEL_XXX constants.

Since: 1.21

Returns: string The model ID

Definition at line 468 of file ContentHandler.php.

Referenced by canBeUsedOn(), checkFormat(), and getSlotDiffRenderer().

◆ getPageLanguage()

ContentHandler::getPageLanguage	(	Title	$title,
		Content	$content = `null`
	)

Get the language in which the content of the given page is written.

This default implementation just returns the content language (except for pages in the MediaWiki namespace)

Note that the page's language is not cacheable, since it may in some cases depend on user settings.

Also note that the page language may or may not depend on the actual content of the page, that is, this method may load the content in order to determine the language.

Since: 1.21

Parameters

Title	$title	The page to determine the language for.
Content \| null	$content	The page's content, if you have it handy, to avoid reloading it.

Returns: Language The page's language

Reimplemented in CodeContentHandler.

Definition at line 683 of file ContentHandler.php.

References $lang, $title, $wgLang, list, NS_MEDIAWIKI, and wfGetLangObj().

Referenced by TextContentHandler\getDataForSearchIndex(), and getPageViewLanguage().

◆ getPageViewLanguage()

ContentHandler::getPageViewLanguage	(	Title	$title,
		Content	$content = `null`
	)

Get the language in which the content of this page is written when viewed by user.

Defaults to $this->getPageLanguage(), but if the user specified a preferred variant, the variant will be used.

This default implementation just returns $this->getPageLanguage( $title, $content ) unless the user specified a preferred variant.

Note that the pages view language is not cacheable, since it depends on user settings.

Also note that the page language may or may not depend on the actual content of the page, that is, this method may load the content in order to determine the language.

Since: 1.21

Parameters

Title	$title	The page to determine the language for.
Content \| null	$content	The page's content, if you have it handy, to avoid reloading it.

Returns: Language The page's language for viewing

Reimplemented in CodeContentHandler.

Definition at line 718 of file ContentHandler.php.

References $content, $title, getPageLanguage(), and NS_MEDIAWIKI.

◆ getParserOutputForIndexing()

ContentHandler::getParserOutputForIndexing	(	WikiPage	$page,
		ParserCache	$cache = `null`
	)

Produce page output suitable for indexing.

Specific content handlers may override it if they need different content handling.

Parameters

WikiPage	$page
ParserCache \| null	$cache

Returns: ParserOutput

Definition at line 1349 of file ContentHandler.php.

References $cache, WikiPage\getRevision(), and WikiPage\makeParserOptions().

◆ getSecondaryDataUpdates()

ContentHandler::getSecondaryDataUpdates	(	Title	$title,
		Content	$content,
			$role,
		SlotRenderingProvider	$slotOutput
	)

Returns a list of DeferrableUpdate objects for recording information about the given Content in some secondary data store.

Application logic should not call this method directly. Instead, it should call DerivedPageDataUpdater::getSecondaryDataUpdates().

Note: Implementations must not return a LinksUpdate instance. Instead, a LinksUpdate is created by the calling code in DerivedPageDataUpdater, on the combined ParserOutput of all slots, not for each slot individually. This is in contrast to the old getSecondaryDataUpdates method defined by AbstractContent, which returned a LinksUpdate.; Implementations should not call $content->getParserOutput, they should call $slotOutput->getSlotRendering( $role, false ) instead if they need to access a ParserOutput of $content. This allows existing ParserOutput objects to be re-used, while avoiding creating a ParserOutput when none is needed.

Parameters

Title	$title	The title of the page to supply the updates for
Content	$content	The content to generate data updates for.
string	$role	The role (slot) in which the content is being used. Which updates are performed should generally not depend on the role the content has, but the DeferrableUpdates themselves may need to know the role, to track to which slot the data refers, and to avoid overwriting data of the same kind from another slot.
SlotRenderingProvider	$slotOutput	A provider that can be used to gain access to a ParserOutput of $content by calling $slotOutput->getSlotParserOutput( $role, false ).

Returns: DeferrableUpdate[] A list of DeferrableUpdate objects for putting information about this content object somewhere. The default implementation returns an empty array.

Since: 1.32

Definition at line 1401 of file ContentHandler.php.

Referenced by WikitextContentHandlerTest\testGetSecondaryDataUpdates().

◆ getSlotDiffRenderer()

ContentHandler::getSlotDiffRenderer ( IContextSource $context )

final

Get an appropriate SlotDiffRenderer for this content model.

Since: 1.32

Parameters

IContextSource $context

Returns: SlotDiffRenderer

Definition at line 616 of file ContentHandler.php.

References $context, $differenceEngine, createDifferenceEngine(), getModelID(), and getSlotDiffRendererInternal().

◆ getSlotDiffRendererInternal()

ContentHandler::getSlotDiffRendererInternal ( IContextSource $context )

protected

Return the SlotDiffRenderer appropriate for this content handler.

Parameters

IContextSource $context

Returns: SlotDiffRenderer

Definition at line 641 of file ContentHandler.php.

References $context, $engine, TextSlotDiffRenderer\ENGINE_EXTERNAL, TextSlotDiffRenderer\ENGINE_PHP, TextSlotDiffRenderer\ENGINE_WIKIDIFF2, and DifferenceEngine\getEngine().

Referenced by getSlotDiffRenderer().

◆ getSupportedFormats()

ContentHandler::getSupportedFormats ( )

Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler.

Since: 1.21

Returns: string[] List of serialization formats as MIME type like strings

Definition at line 497 of file ContentHandler.php.

◆ getUndoContent()

ContentHandler::getUndoContent	(	$current,
		$undo,
		$undoafter,
		$undoIsLatest = `false`
	)

Get the Content object that needs to be saved in order to undo all revisions between $undo and $undoafter.

Revisions must belong to the same page, must exist and must not be deleted.

Since: 1.21; 1.32 accepts Content objects for all parameters instead of Revision objects. Passing Revision objects is deprecated.

Parameters

Revision \| Content	$current	The current text
Revision \| Content	$undo	The content of the revision to undo
Revision \| Content	$undoafter	Must be from an earlier revision than $undo
bool	$undoIsLatest	Set true if $undo is from the current revision (since 1.32)

Returns: mixed Content on success, false on failure

Definition at line 1101 of file ContentHandler.php.

References $e, checkModelID(), and merge3().

◆ importTransform()

ContentHandler::importTransform	(	$blob,
		$format = `null`
	)

Apply import transformation (per default, returns $blob unchanged).

This gives subclasses an opportunity to transform data blobs on import.

Since: 1.24

Parameters

string	$blob
string \| null	$format

Returns: string

Definition at line 425 of file ContentHandler.php.

References $blob.

◆ isParserCacheSupported()

ContentHandler::isParserCacheSupported ( )

Returns true for content models that support caching using the ParserCache mechanism.

See WikiPage::shouldCheckParserCache().

Since: 1.21

Returns: bool Always false.

Reimplemented in WikitextContentHandler.

Definition at line 1188 of file ContentHandler.php.

◆ isSupportedFormat()

ContentHandler::isSupportedFormat ( $format )

Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise.

Note that if $format is null, this method always returns true, because null means "use the default format".

Since: 1.21

Parameters

string $format The serialization format to check

Returns: bool

Definition at line 529 of file ContentHandler.php.

Referenced by checkFormat().

◆ makeContent()

static ContentHandler::makeContent	(		$text,
		Title	$title = `null`,
			$modelId = `null`,
			$format = `null`
	)

static

Convenience function for creating a Content object from a given textual representation.

$text will be deserialized into a Content object of the model specified by $modelId (or, if that is not given, $title->getContentModel()) using the given format.

Since: 1.21

Parameters

string	$text	The textual representation, will be unserialized to create the Content object
Title \| null	$title	The title of the page this text belongs to. Required if $modelId is not provided.
string \| null	$modelId	The model to deserialize to. If not provided, $title->getContentModel() is used.
string \| null	$format	The format to use for deserialization. If not given, the model's default format is used.

Exceptions

MWException If model ID or format is not supported or if the text can not be unserialized using the format.

Returns: Content A Content object representing the text.

Definition at line 133 of file ContentHandler.php.

References $handler, and $title.

Referenced by MediaWiki\EditPage\TextConflictHelper\toEditContent().

◆ makeEmptyContent()

ContentHandler::makeEmptyContent ( )

abstract

Creates an empty Content object of the type supported by this ContentHandler.

Since: 1.21

Returns: Content

Reimplemented in JsonContentHandler, TextContentHandler, RevisionTestModifyableContentHandler, DummyContentHandlerForTesting, and DummyNonTextContentHandler.

◆ makeParserOptions()

ContentHandler::makeParserOptions ( $context )

Get parser options suitable for rendering and caching the article.

Deprecated:: since 1.32, use WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.

Parameters

IContextSource | User | string

$context

One of the following:

IContextSource: Use the User and the Language of the provided context
User: Use the provided User object and $wgLang for the language, so use an IContextSource object if possible.
'canonical': Canonical options (anonymous user with default preferences and content language).

Exceptions

MWException

Returns: ParserOptions

Definition at line 1175 of file ContentHandler.php.

References $context, and wfDeprecated().

◆ makeRedirectContent()

ContentHandler::makeRedirectContent	(	Title	$destination,
			$text = `''`
	)

Creates a new Content object that acts as a redirect to the given page, or null if redirects are not supported by this content model.

This default implementation always returns null. Subclasses supporting redirects must override this method.

Note that subclasses that override this method to return a Content object should also override supportsRedirects() to return true.

Since: 1.21

Parameters

Title	$destination	The page to redirect to.
string	$text	Text to include in the redirect, if possible.

Returns: Content Always null.

Reimplemented in CssContentHandler, JavaScriptContentHandler, and WikitextContentHandler.

Definition at line 456 of file ContentHandler.php.

◆ merge3()

ContentHandler::merge3	(	Content	$oldContent,
		Content	$myContent,
		Content	$yourContent
	)

Attempts to merge differences between three versions.

Returns a new Content object for a clean merge and false for failure or a conflict.

This default implementation always returns false.

Since: 1.21

Parameters

Content	$oldContent	The page's previous content.
Content	$myContent	One of the page's conflicting contents.
Content	$yourContent	One of the page's conflicting contents.

Returns: Content|bool Always false.

Reimplemented in TextContentHandler.

Definition at line 784 of file ContentHandler.php.

Referenced by getUndoContent().

◆ serializeContent()

ContentHandler::serializeContent	(	Content	$content,
			$format = `null`
	)

abstract

Serializes a Content object of the type supported by this ContentHandler.

Since: 1.21

Parameters

Content	$content	The Content object to serialize
string \| null	$format	The desired serialization format

Returns: string Serialized form of the content

Reimplemented in TextContentHandler, WikitextContentHandler, DummyContentHandlerForTesting, and DummyNonTextContentHandler.

◆ supportsCategories()

ContentHandler::supportsCategories ( )

Returns true if this content model supports categories.

The default implementation returns true.

Returns: bool Always true.

Definition at line 1211 of file ContentHandler.php.

◆ supportsDirectApiEditing()

ContentHandler::supportsDirectApiEditing ( )

Whether or not this content model supports direct editing via ApiEditPage.

Returns: bool Default is false, and true for TextContent and derivatives.

Reimplemented in DummyNonTextContentHandler, and DummySerializeErrorContentHandler.

Definition at line 1242 of file ContentHandler.php.

References supportsDirectEditing().

◆ supportsDirectEditing()

ContentHandler::supportsDirectEditing ( )

Return true if this content model supports direct editing, such as via EditPage.

Returns: bool Default is false, and true for TextContent and it's derivatives.

Reimplemented in TextContentHandler.

Definition at line 1233 of file ContentHandler.php.

Referenced by supportsDirectApiEditing(), and WikitextContentHandlerTest\testSupportsDirectEditing().

◆ supportsRedirects()

ContentHandler::supportsRedirects ( )

Returns true if this content model supports redirects.

This default implementation returns false.

Content models that return true here should also implement ContentHandler::makeRedirectContent to return a Content object.

Returns: bool Always false.

Reimplemented in CssContentHandler, JavaScriptContentHandler, and WikitextContentHandler.

Definition at line 1224 of file ContentHandler.php.

◆ supportsSections()

ContentHandler::supportsSections ( )

Returns true if this content model supports sections.

This default implementation returns false.

Content models that return true here should also implement Content::getSection, Content::replaceSection, etc. to handle sections..

Returns: bool Always false.

Reimplemented in WikitextContentHandler.

Definition at line 1201 of file ContentHandler.php.

◆ unserializeContent()

ContentHandler::unserializeContent	(	$blob,
		$format = `null`
	)

abstract

Unserializes a Content object of the type supported by this ContentHandler.

Since: 1.21

Parameters

string	$blob	Serialized form of the content
string \| null	$format	The format used for serialization

Returns: Content The Content object created by deserializing $blob

Reimplemented in DummyContentHandlerForTesting, DummyNonTextContentHandler, DummySerializeErrorContentHandler, TextContentHandler, and RevisionTestModifyableContentHandler.

Member Data Documentation

◆ $handlers

array ContentHandler::$handlers

staticprotected

A Cache of ContentHandler instances by model id.

Definition at line 224 of file ContentHandler.php.

◆ $mModelID

string ContentHandler::$mModelID

protected

Definition at line 355 of file ContentHandler.php.

◆ $mSupportedFormats

string [] ContentHandler::$mSupportedFormats

protected

Definition at line 360 of file ContentHandler.php.

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

includes/content/ContentHandler.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSearchField()

◆ canBeUsedOn()

◆ checkFormat()

◆ checkModelID()

◆ cleanupHandlersCache()

◆ createDifferenceEngine()

◆ exportTransform()

◆ getActionOverrides()

◆ getAllContentFormats()

◆ getAutoDeleteReason()

◆ getAutosummary()

◆ getChangeTag()

◆ getChangeType()

◆ getContentModels()

◆ getContentText()

◆ getDataForSearchIndex()

◆ getDefaultFormat()

◆ getDefaultModelFor()

◆ getDeletionUpdates()

◆ getDiffEngineClass()

◆ getFieldsForSearchIndex()

◆ getForContent()

◆ getForModelID()

◆ getForTitle()

◆ getLocalizedName()

◆ getModelID()

◆ getPageLanguage()

◆ getPageViewLanguage()

◆ getParserOutputForIndexing()

◆ getSecondaryDataUpdates()

◆ getSlotDiffRenderer()

◆ getSlotDiffRendererInternal()

◆ getSupportedFormats()

◆ getUndoContent()

◆ importTransform()

◆ isParserCacheSupported()

◆ isSupportedFormat()

◆ makeContent()

◆ makeEmptyContent()

◆ makeParserOptions()

◆ makeRedirectContent()

◆ merge3()

◆ serializeContent()

◆ supportsCategories()

◆ supportsDirectApiEditing()

◆ supportsDirectEditing()

◆ supportsRedirects()

◆ supportsSections()

◆ unserializeContent()

Member Data Documentation

◆ $handlers

◆ $mModelID

◆ $mSupportedFormats