Content object implementation for representing flat text. More...

Inheritance diagram for TextContent:

[legend]

Collaboration diagram for TextContent:

[legend]

Public Member Functions
	__construct ( $text, $model_id=CONTENT_MODEL_TEXT)

	convert ( $toModel, $lossy='')
	This implementation provides lossless conversion between content models based on TextContent. More...

	copy ()

	diff (Content $that, Language $lang=null)
	Diff this content object with another content object. More...

	getNativeData ()
	Returns the text represented by this Content object, as a string. More...

	getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
	Returns a generic ParserOutput object, wrapping the HTML returned by getHtml(). More...

	getSize ()
	returns the text's size in bytes. More...

	getTextForSearchIndex ()
	Returns the text represented by this Content object, as a string. More...

	getTextForSummary ( $maxlength=250)
	Returns a textual representation of the content suitable for use in edit summaries and log messages. More...

	getWikitextForTransclusion ()
	Returns attempts to convert this content object to wikitext, and then returns the text string. More...

	isCountable ( $hasLinks=null)
	Returns true if this content is not a redirect, and $wgArticleCountMethod is "any". More...

	preSaveTransform (Title $title, User $user, ParserOptions $popts)
	Returns a Content object with pre-save transformations applied. More...

Public Member Functions inherited from AbstractContent
	__construct ( $modelId=null)

	addSectionHeader ( $header)

	equals (Content $that=null)

	getContentHandler ()

	getDefaultFormat ()

	getDeletionUpdates (WikiPage $page, ParserOutput $parserOutput=null)

	getModel ()

	getRedirectChain ()

	getRedirectTarget ()
	Subclasses that implement redirects should override this. More...

	getSecondaryDataUpdates (Title $title, Content $old=null, $recursive=true, ParserOutput $parserOutput=null)
	Returns a list of DataUpdate objects for recording information about this Content in some secondary data store. More...

	getSection ( $sectionId)

	getSupportedFormats ()

	getUltimateRedirectTarget ()

	isEmpty ()

	isRedirect ()

	isSupportedFormat ( $format)

	isValid ()
	Subclasses may override this to implement (light weight) validation. More...

	matchMagicWord (MagicWord $word)
	This default implementation always returns false. More...

	preloadTransform (Title $title, ParserOptions $popts, $params=array())

	prepareSave (WikiPage $page, $flags, $baseRevId, User $user)

	replaceSection ( $section, Content $with, $sectionTitle='')

	serialize ( $format=null)

	updateRedirect (Title $target)
	This default implementation always returns $this. More...

Protected Member Functions
	getHighlightHtml ()
	Generates a syntax-highlighted version of the content, as HTML. More...

	getHtml ()
	Generates an HTML version of the content, for display. More...

Protected Member Functions inherited from AbstractContent
	checkFormat ( $format)

	checkModelID ( $modelId)

Additional Inherited Members
Protected Attributes inherited from AbstractContent
string	$model_id
	Name of the content model this Content object represents. More...

Detailed Description

Content object implementation for representing flat text.

TextContent instances are immutable

Definition at line 35 of file TextContent.php.

Constructor & Destructor Documentation

◆ __construct()

TextContent::__construct	(	$text,
		$model_id = `CONTENT_MODEL_TEXT`
	)

Parameters

string	$text
string	$model_id

Definition at line 41 of file TextContent.php.

References AbstractContent\$model_id, and wfWarn().

Member Function Documentation

◆ convert()

TextContent::convert	(	$toModel,
		$lossy = `''`
	)

This implementation provides lossless conversion between content models based on TextContent.

Parameters

string	$toModel
string	$lossy

Returns: Content|bool

See also: Content::convert()

Reimplemented from AbstractContent.

Definition at line 279 of file TextContent.php.

References ContentHandler\getForModelID(), and getNativeData().

Referenced by getWikitextForTransclusion().

◆ copy()

TextContent::copy ( )

Note: Mutable subclasses MUST override this to return a copy!

Returns: Content $this

Implements Content.

Reimplemented in RevisionTestModifyableContent.

Definition at line 63 of file TextContent.php.

References are, and is().

Referenced by WikitextContent\replaceSection().

◆ diff()

TextContent::diff	(	Content	$that,
		Language	$lang = `null`
	)

Diff this content object with another content object.

Since: 1.21

Parameters

Content	$that	The other content object to compare this content object to.
Language	$lang	The language object to use for text segmentation. If not given, $wgContentLang is used.

Returns: Diff A diff representing the changes that would have to be made to this content object to make it equal to $that.

Definition at line 181 of file TextContent.php.

References $wgContLang, AbstractContent\checkModelID(), Content\getModel(), Content\getNativeData(), getNativeData(), and global.

◆ getHighlightHtml()

TextContent::getHighlightHtml ( )

protected

Generates a syntax-highlighted version of the content, as HTML.

Used by the default implementation of getHtml().

Returns: string A HTML representation of the content's markup

Definition at line 263 of file TextContent.php.

References getNativeData().

Referenced by JavaScriptContent\getHtml(), CssContent\getHtml(), and getHtml().

◆ getHtml()

TextContent::getHtml ( )

protected

Generates an HTML version of the content, for display.

Used by getParserOutput() to construct a ParserOutput object.

This default implementation just calls getHighlightHtml(). Content models that have another mapping to HTML (as is the case for markup languages like wikitext) should override this method to generate the appropriate HTML.

Returns: string An HTML representation of the content

Reimplemented in WikitextContent, CssContent, and JavaScriptContent.

Definition at line 253 of file TextContent.php.

References getHighlightHtml().

Referenced by getParserOutput().

◆ getNativeData()

TextContent::getNativeData ( )

Returns the text represented by this Content object, as a string.

Returns: string The raw text.

Implements Content.

Definition at line 118 of file TextContent.php.

Referenced by WikitextContent\addSectionHeader(), convert(), diff(), getHighlightHtml(), getParserOutput(), WikitextContent\getParserOutput(), WikitextContent\getRedirectTarget(), WikitextContent\getSection(), getSize(), getTextForSearchIndex(), getTextForSummary(), WikitextContent\isCountable(), WikitextContent\matchMagicWord(), WikitextContent\preloadTransform(), JavaScriptContent\preSaveTransform(), CssContent\preSaveTransform(), WikitextContent\preSaveTransform(), preSaveTransform(), WikitextContent\replaceSection(), and WikitextContent\updateRedirect().

◆ getParserOutput()

TextContent::getParserOutput	(	Title	$title,
			$revId = `null`,
		ParserOptions	$options = `null`,
			$generateHtml = `true`
	)

Returns a generic ParserOutput object, wrapping the HTML returned by getHtml().

Parameters

Title	$title	Context title for parsing
int	$revId	Revision ID (for {{REVISIONID}})
ParserOptions	$options	Parser options
bool	$generateHtml	Whether or not to generate HTML

Returns: ParserOutput Representing the HTML form of the text.

Implements Content.

Reimplemented in WikitextContent.

Definition at line 215 of file TextContent.php.

References $html, $options, $wgParser, AbstractContent\getContentHandler(), getHtml(), AbstractContent\getModel(), getNativeData(), and global.

◆ getSize()

TextContent::getSize ( )

returns the text's size in bytes.

Returns: int The size

Implements Content.

Definition at line 84 of file TextContent.php.

References getNativeData().

◆ getTextForSearchIndex()

TextContent::getTextForSearchIndex ( )

Returns the text represented by this Content object, as a string.

Returns: string The raw text.

Implements Content.

Definition at line 129 of file TextContent.php.

References getNativeData().

◆ getTextForSummary()

TextContent::getTextForSummary ( $maxLength = 250 )

Returns a textual representation of the content suitable for use in edit summaries and log messages.

Since: 1.21

Parameters

int $maxLength Maximum length of the summary text.

Returns: string The summary text.

Implements Content.

Reimplemented in WikitextContent.

Definition at line 67 of file TextContent.php.

References $wgContLang, getNativeData(), and global.

◆ getWikitextForTransclusion()

TextContent::getWikitextForTransclusion ( )

Returns attempts to convert this content object to wikitext, and then returns the text string.

The conversion may be lossy.

Note: : this allows any text-based content to be transcluded as if it was wikitext.

Returns: string|false The raw text, or false if the conversion failed.

Implements Content.

Definition at line 141 of file TextContent.php.

References CONTENT_MODEL_WIKITEXT, and convert().

◆ isCountable()

TextContent::isCountable ( $hasLinks = null )

Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".

Parameters

bool $hasLinks If it is known whether this content contains links, provide this information here, to avoid redundant parsing to find out.

Returns: bool

Implements Content.

Definition at line 99 of file TextContent.php.

References global, and AbstractContent\isRedirect().

◆ preSaveTransform()

TextContent::preSaveTransform	(	Title	$title,
		User	$user,
		ParserOptions	$popts
	)

Returns a Content object with pre-save transformations applied.

This implementation just trims trailing whitespace.

Parameters

Title	$title
User	$user
ParserOptions	$popts

Returns: Content

Reimplemented from AbstractContent.

Reimplemented in WikitextContent, CssContent, and JavaScriptContent.

Definition at line 161 of file TextContent.php.

References getNativeData().

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

includes/content/TextContent.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convert()

◆ copy()

◆ diff()

◆ getHighlightHtml()

◆ getHtml()

◆ getNativeData()

◆ getParserOutput()

◆ getSize()

◆ getTextForSearchIndex()

◆ getTextForSummary()

◆ getWikitextForTransclusion()

◆ isCountable()

◆ preSaveTransform()