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

Inheritance diagram for TextContent:

Collaboration diagram for TextContent:

Public Member Functions
	__construct ($text, $model_id=CONTENT_MODEL_TEXT)
	convert ($toModel, $lossy= '')
	This implementation provides lossless conversion between content models based on TextContent.
	copy ()
	diff (Content $that, Language $lang=null)
	Diff this content object with another content object.
	getNativeData ()
	Returns the text represented by this Content object, as a string.
	getSize ()
	Returns the text's size in bytes.
	getTextForSearchIndex ()
	Returns the text represented by this Content object, as a string.
	getTextForSummary ($maxlength=250)
	Returns a textual representation of the content suitable for use in edit summaries and log messages.
	getWikitextForTransclusion ()
	Returns attempts to convert this content object to wikitext, and then returns the text string.
	isCountable ($hasLinks=null)
	Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
	preSaveTransform (Title $title, User $user, ParserOptions $popts)
	Returns a Content object with pre-save transformations applied.
Protected Member Functions
	fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
	Fills the provided ParserOutput object with information derived from the content.
	getHighlightHtml ()
	Generates an HTML version of the content, for display.
	getHtml ()
	Generates an HTML version of the content, for display.

Detailed Description

Content object implementation for representing flat text.

TextContent instances are immutable

Definition at line 35 of file TextContent.php.

Constructor & Destructor Documentation

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

Parameters:

string	$text
string	$model_id

Reimplemented in CssContent, JavaScriptContent, and JsonContent.

Definition at line 41 of file TextContent.php.

References AbstractContent\$model_id, and wfWarn().

Member Function Documentation

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

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

Parameters:

string	$toModel	The desired content model, use the CONTENT_MODEL_XXX flags.
string	$lossy	Flag, set to "lossy" to allow lossy conversion. If lossy conversion is not allowed, full round-trip conversion is expected to work without losing information.

Returns:: Content|bool A content object with the content model $toModel, or false if that conversion is not supported.

See also:: Content::convert()

Reimplemented from AbstractContent.

Definition at line 287 of file TextContent.php.

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

Referenced by getWikitextForTransclusion().

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().

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 178 of file TextContent.php.

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

TextContent::fillParserOutput	(	Title $	title,
		$	revId,
		ParserOptions $	options,
		$	generateHtml,
		ParserOutput &$	output
	)		`[protected]`

Fills the provided ParserOutput object with information derived from the content.

Unless $generateHtml was false, this includes an HTML representation of the content provided by getHtml().

For content models listed in $wgTextModelsToParse, this method will call the MediaWiki wikitext parser on the text to extract any (wikitext) links, magic words, etc.

Subclasses may override this to provide custom content processing. For custom HTML generation alone, it is sufficient to override 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
ParserOutput	$output	The output object to fill (reference).

Reimplemented from AbstractContent.

Reimplemented in WikitextContent, and JsonContent.

Definition at line 218 of file TextContent.php.

References $generateHtml, $html, $revId, $wgParser, getHtml(), AbstractContent\getModel(), getNativeData(), global, and ParserOutput\setText().

TextContent::getHighlightHtml ( ) [protected]

Generates an HTML version of the content, for display.

This default implementation returns an HTML-escaped version of the raw text content.

Note:: The functionality of this method should really be implemented in getHtml(), and subclasses should override getHtml() if needed. getHighlightHtml() is kept around for backward compatibility with extensions that already override it.

Deprecated:: since 1.24. Use getHtml() instead. In particular, subclasses overriding getHighlightHtml() should override getHtml() instead.

Returns:: string An HTML representation of the content

Definition at line 270 of file TextContent.php.

References getNativeData().

Referenced by getHtml().

TextContent::getHtml ( ) [protected]

Generates an HTML version of the content, for display.

Used by fillParserOutput() to provide HTML for the ParserOutput object.

Subclasses may override this to provide a custom HTML rendering. If further information is to be derived from the content (such as categories), the fillParserOutput() method can be overridden instead.

For backwards-compatibility, this default implementation just calls getHighlightHtml().

Returns:: string An HTML representation of the content

Reimplemented in WikitextContent, CssContent, and JavaScriptContent.

Definition at line 250 of file TextContent.php.

References getHighlightHtml().

Referenced by fillParserOutput().

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(), JsonContent\beautifyJSON(), convert(), diff(), fillParserOutput(), getHighlightHtml(), JavaScriptContent\getHtml(), CssContent\getHtml(), JsonContent\getJsonData(), WikitextContent\getRedirectTargetAndText(), WikitextContent\getSection(), getSize(), getTextForSearchIndex(), getTextForSummary(), WikitextContent\isCountable(), WikitextContent\matchMagicWord(), WikitextContent\preloadTransform(), JavaScriptContent\preSaveTransform(), CssContent\preSaveTransform(), WikitextContent\preSaveTransform(), preSaveTransform(), WikitextContent\replaceSection(), and WikitextContent\updateRedirect().

TextContent::getSize ( )

Returns the text's size in bytes.

Returns:: int

Implements Content.

Definition at line 84 of file TextContent.php.

References getNativeData().

TextContent::getTextForSearchIndex ( )

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

Returns:: string The raw text.

Implements Content.

Definition at line 127 of file TextContent.php.

References getNativeData().

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.

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|bool The raw text, or false if the conversion failed.

Implements Content.

Definition at line 139 of file TextContent.php.

References convert().

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().

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, JsonContent, CssContent, and JavaScriptContent.

Definition at line 159 of file TextContent.php.

References AbstractContent\getModel(), and getNativeData().

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

includes/content/TextContent.php

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation