Base content handler implementation for flat text contents. More...

Inheritance diagram for TextContentHandler:

Collaboration diagram for TextContentHandler:

Public Member Functions
	__construct ($modelId=CONTENT_MODEL_TEXT, $formats=[CONTENT_FORMAT_TEXT])

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

	getFieldsForSearchIndex (SearchEngine $engine)

	makeEmptyContent ()
	Creates an empty TextContent object. More...

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

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

	supportsDirectEditing ()

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

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

	canBeUsedOn (Title $title)
	Determines whether the content type handled by this ContentHandler can be used on the given page. More...

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

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

	getActionOverrides ()
	Returns overrides for action handlers. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	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. More...

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

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

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

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

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

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

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

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

Protected Member Functions
	getContentClass ()
	Returns the name of the associated Content class, to be used when creating new objects. More...

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

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

	checkModelID ($model_id)

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

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. More...

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

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

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

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

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

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

static	runLegacyHooks ($event, $args=[], $deprecatedVersion=null)
	Call a legacy hook that uses text instead of Content objects. More...

Protected Attributes inherited from ContentHandler
string	$mModelID

string[]	$mSupportedFormats

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

Detailed Description

Base content handler implementation for flat text contents.

Definition at line 31 of file TextContentHandler.php.

Constructor & Destructor Documentation

TextContentHandler::__construct	(	$modelId = `CONTENT_MODEL_TEXT`,
		$formats = `[ CONTENT_FORMAT_TEXT ]`
	)

Definition at line 34 of file TextContentHandler.php.

Member Function Documentation

TextContentHandler::getContentClass ( )

protected

Returns the name of the associated Content class, to be used when creating new objects.

Override expected by subclasses.

Since: 1.24

Returns: string

Definition at line 103 of file TextContentHandler.php.

References class.

Referenced by makeEmptyContent(), and unserializeContent().

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

Definition at line 153 of file TextContentHandler.php.

References WikiPage\getContent(), ContentHandler\getPageLanguage(), and WikiPage\getTitle().

TextContentHandler::getFieldsForSearchIndex ( SearchEngine $engine )

Definition at line 145 of file TextContentHandler.php.

References SearchIndexField\INDEX_TYPE_KEYWORD, and SearchEngine\makeSearchFieldMapping().

TextContentHandler::makeEmptyContent ( )

Creates an empty TextContent object.

Since: 1.21

Returns: Content A new TextContent object with empty text.

Definition at line 131 of file TextContentHandler.php.

References getContentClass().

Referenced by merge3().

TextContentHandler::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.

All three Content objects passed as parameters must have the same content model.

This text-based implementation uses wfMerge().

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.