Content handler implementation for unknown content. More...

Inheritance diagram for FallbackContentHandler:

Collaboration diagram for FallbackContentHandler:

Public Member Functions
	__construct ( $modelId, $formats=null)
	Constructs an FallbackContentHandler.

	makeEmptyContent ()
	Creates an empty FallbackContent object.

	serializeContent (Content $content, $format=null)
	Returns the content's data as-is.

	supportsDirectEditing ()

	unserializeContent ( $blob, $format=null)
	Constructs an FallbackContent instance wrapping the given data.

Public Member Functions inherited from ContentHandler
	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).

	fillParserOutputInternal (Content $content, ContentParseParams $cpoParams, ParserOutput &$output)
	A temporary layer to move AbstractContent::fillParserOutput to ContentHandler::fillParserOutput.

	generateHTMLOnEdit ()
	Whether an edit on the content should trigger an HTML render and ParserCache entry.

	getActionOverrides ()
	Returns overrides for action handlers.

	getAutoDeleteReason (Title $title, &$hasHistory=false)
	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.

	getParserOutput (Content $content, ContentParseParams $cpoParams)
	Returns a ParserOutput object containing information derived from this content.

	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, array $options=[])
	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 (Content $currentContent, Content $undoContent, Content $undoAfterContent, $undoIsLatest=false)
	Get the Content object that needs to be saved in order to undo all changes 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.

	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.

	preloadTransform (Content $content, PreloadTransformParams $pltParams)
	Returns a $content object with preload transformations applied (or the same object if no transformations apply).

	preSaveTransform (Content $content, PreSaveTransformParams $pstParams)
	Returns a $content object with pre-save transformations applied (or the same object if no transformations apply).

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

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

	supportsPreloadContent ()
	If a non-existing page can be created with the contents from another (arbitrary) page being preloaded in the editor, see {.

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

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

	validateSave (Content $content, ValidationParams $validationParams)
	Validate content for saving it.

Protected Member Functions
	fillParserOutput (Content $content, ContentParseParams $cpoParams, ParserOutput &$output)
	Fills the ParserOutput with an error message.

	getSlotDiffRendererInternal (IContextSource $context)

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

	callDeprecatedContentGPO (Content $content, ContentParseParams $cpoParams)
	If provided content overrides deprecated Content::getParserOutput, call it and return.

	callDeprecatedContentPLT (Content $content, PreloadTransformParams $params)
	If provided content overrides deprecated Content::preloadTransform, call it and return.

	callDeprecatedContentPST (Content $content, PreSaveTransformParams $params)
	Provided content overrides deprecated Content::preSaveTransform, call it and return.

	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.

	getSlotDiffRendererWithOptions (IContextSource $context, $options=[])
	Return the SlotDiffRenderer appropriate for this content handler.

	latestRevision (WikiPage $page)
	Get the latest revision of the given $page, fetching it from the primary if necessary.

	shouldCallDeprecatedContentTransformMethod (Content $content, $params)
	Check if we need to provide content overrides deprecated Content method.

Additional Inherited Members
Static Public Member Functions inherited from ContentHandler
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 Attributes inherited from ContentHandler
string	$mModelID

string[]	$mSupportedFormats

Detailed Description

Content handler implementation for unknown content.

This can be used to handle content for which no ContentHandler exists on the system, perhaps because the extension that provided it has been removed.

Definition at line 36 of file FallbackContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

FallbackContentHandler::__construct	(		$modelId,
			$formats = null )

Constructs an FallbackContentHandler.

Since FallbackContentHandler can be registered for multiple model IDs on a system, multiple instances of FallbackContentHandler may coexist.

To preserve the serialization format of the original content model, it must be supplied to the constructor via the $formats parameter. If not given, the default format is reported as 'application/octet-stream'.

Parameters

string	$modelId
string[] \| null	$formats

Reimplemented from ContentHandler.

Definition at line 50 of file FallbackContentHandler.php.

Member Function Documentation

◆ fillParserOutput()

FallbackContentHandler::fillParserOutput	(	Content	$content,
		ContentParseParams	$cpoParams,
		ParserOutput &	$output )

protected

Fills the ParserOutput with an error message.

Since: 1.38

Parameters

Content	$content
ContentParseParams	$cpoParams
ParserOutput	&$output	The output object to fill (reference).

Reimplemented from ContentHandler.

Definition at line 117 of file FallbackContentHandler.php.

References $content, ParserOutput\setText(), and wfMessage().

◆ getSlotDiffRendererInternal()

FallbackContentHandler::getSlotDiffRendererInternal ( IContextSource $context )

protected

Parameters

IContextSource $context

Returns: SlotDiffRenderer

Reimplemented from ContentHandler.

Definition at line 133 of file FallbackContentHandler.php.

◆ makeEmptyContent()

FallbackContentHandler::makeEmptyContent ( )

Creates an empty FallbackContent object.

Since: 1.21

Returns: Content A new FallbackContent object with empty text.

Reimplemented from ContentHandler.

Definition at line 98 of file FallbackContentHandler.php.

References unserializeContent().

◆ serializeContent()

FallbackContentHandler::serializeContent	(	Content	$content,
			$format = null )

Returns the content's data as-is.

Parameters

Content	$content
string \| null	$format	The serialization format to check

Returns: mixed

Reimplemented from ContentHandler.

Definition at line 71 of file FallbackContentHandler.php.

References $content.

◆ supportsDirectEditing()

FallbackContentHandler::supportsDirectEditing ( )

Returns: false

Reimplemented from ContentHandler.

Definition at line 105 of file FallbackContentHandler.php.

◆ unserializeContent()

FallbackContentHandler::unserializeContent	(		$blob,
			$format = null )

Constructs an FallbackContent instance wrapping the given data.

Since: 1.21

Parameters

string	$blob	serialized content in an unknown format
string \| null	$format	ignored

Returns: Content The FallbackContent object wrapping $data

Reimplemented from ContentHandler.

Definition at line 87 of file FallbackContentHandler.php.

References $blob, and ContentHandler\getModelID().

Referenced by makeEmptyContent().

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

includes/content/FallbackContentHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillParserOutput()

◆ getSlotDiffRendererInternal()

◆ makeEmptyContent()

◆ serializeContent()

◆ supportsDirectEditing()

◆ unserializeContent()