Content object for wiki text pages. More...

Inheritance diagram for WikitextContent:

[legend]

Collaboration diagram for WikitextContent:

[legend]

Public Member Functions
	__construct ( $text)
	Stable to call.

	addSectionHeader ( $header)
	Returns a new WikitextContent object with the given section heading prepended.

	getRedirectTarget ()
	Implement redirect extraction for wikitext.

	getSection ( $sectionId)

	getTextForSummary ( $maxlength=250)

	isCountable ( $hasLinks=null, Title $title=null)
	Returns true if this content is not a redirect, and this content's text is countable according to the criteria defined by $wgArticleCountMethod.

	matchMagicWord (MagicWord $word)
	This implementation calls $word->match() on the this TextContent object's text.

	preloadTransform (Title $title, ParserOptions $popts, $params=[])
	Returns a Content object with preload transformations applied (or this object if no transformations apply).

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

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

	updateRedirect (Title $target)
	This implementation replaces the first link on the page with the given new target if this Content object is a redirect.

Public Member Functions inherited from TextContent
	__construct ( $text, $model_id=CONTENT_MODEL_TEXT)
	Stable to call.

	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.

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

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

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

Public Member Functions inherited from AbstractContent
	equals (Content $that=null)
	Decides whether two Content objects are equal.

	getContentHandler ()

	getDefaultFormat ()

	getDeletionUpdates (WikiPage $page, ParserOutput $parserOutput=null)
	Stable to override.

	getModel ()

	getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
	Returns a ParserOutput object containing information derived from this content.

	getRedirectChain ()

	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.

	getSupportedFormats ()

	getUltimateRedirectTarget ()

	isEmpty ()
	Stable to override.

	isRedirect ()

	isSupportedFormat ( $format)

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

	prepareSave (WikiPage $page, $flags, $parentRevId, User $user)
	Stable to override.

	serialize ( $format=null)
	Stable to override.

Protected Member Functions
	fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
	Returns a ParserOutput object resulting from parsing the content's text using the global Parser service.

	getHtml ()

	getRedirectTargetAndText ()
	Extract the redirect target and the remaining text on the page.

Protected Member Functions inherited from AbstractContent
	checkFormat ( $format)

	checkModelID ( $modelId)

	equalsInternal (Content $that)
	Checks whether $that is logically equal to this Content object.

	getContentHandlerFactory ()

Private Attributes
bool	$hadSignature = false
	Tracks if the parser set the user-signature flag when creating this content, which would make it expire faster in ApiStashEdit.

string null	$previousParseStackTrace = null
	Stack trace of the previous parse.

	$redirectTargetAndText = null

Additional Inherited Members
Static Public Member Functions inherited from TextContent
static	normalizeLineEndings ( $text)
	Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace.

Protected Attributes inherited from TextContent
string	$mText

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

Detailed Description

Content object for wiki text pages.

@newable

Definition at line 37 of file WikitextContent.php.

Constructor & Destructor Documentation

◆ __construct()

WikitextContent::__construct ( $text )

Stable to call.

Parameters

string $text

Reimplemented from AbstractContent.

Definition at line 56 of file WikitextContent.php.

References CONTENT_MODEL_WIKITEXT.

Member Function Documentation

◆ addSectionHeader()

WikitextContent::addSectionHeader ( $header )

Returns a new WikitextContent object with the given section heading prepended.

Parameters

string $header

Returns: Content

Reimplemented from AbstractContent.

Definition at line 136 of file WikitextContent.php.

References $header, TextContent\getText(), and wfMessage().

◆ fillParserOutput()

WikitextContent::fillParserOutput	(	Title	$title,
			$revId,
		ParserOptions	$options,
			$generateHtml,
		ParserOutput &	$output
	)

protected

Returns a ParserOutput object resulting from parsing the content's text using the global Parser service.

Parameters

Title	$title
int \| null	$revId	ID of the revision being rendered. See Parser::parse() for the ramifications. (default: null)
ParserOptions	$options	(default: null)
bool	$generateHtml	(default: true)
ParserOutput	&$output	ParserOutput representing the HTML form of the text, may be manipulated or replaced.

Reimplemented from TextContent.

Definition at line 347 of file WikitextContent.php.

References $title, ParserOutput\addLink(), ParserOutput\addModuleStyles(), ParserOutput\getRawText(), AbstractContent\getRedirectChain(), getRedirectTargetAndText(), ParserOptions\optionsHash(), ParserOutput\setFlag(), and ParserOutput\setText().

◆ getHtml()

WikitextContent::getHtml ( )

protected

Exceptions

MWException

Reimplemented from TextContent.

Definition at line 399 of file WikitextContent.php.

◆ getRedirectTarget()

WikitextContent::getRedirectTarget ( )

Implement redirect extraction for wikitext.

Returns: Title|null

See also: Content::getRedirectTarget

Reimplemented from AbstractContent.

Definition at line 251 of file WikitextContent.php.

References $title, and getRedirectTargetAndText().

◆ getRedirectTargetAndText()

WikitextContent::getRedirectTargetAndText ( )

protected

Extract the redirect target and the remaining text on the page.

Note: migrated here from Title::newFromRedirectInternal()

Since: 1.23

Returns: array List of two elements: Title|null and string.

Definition at line 201 of file WikitextContent.php.

References $redirectTargetAndText, $title, $wgMaxRedirects, TextContent\getText(), and Title\isValidRedirectTarget().

Referenced by fillParserOutput(), and getRedirectTarget().

◆ getSection()

WikitextContent::getSection ( $sectionId )

Parameters

string | int $sectionId

Returns: Content|bool|null

See also: Content::getSection()

Reimplemented from AbstractContent.

Definition at line 67 of file WikitextContent.php.

References TextContent\getText().

◆ getTextForSummary()

WikitextContent::getTextForSummary ( $maxlength = 250 )

Parameters

int $maxlength

Returns: string

Reimplemented from TextContent.

Definition at line 324 of file WikitextContent.php.

◆ isCountable()

WikitextContent::isCountable	(		$hasLinks = `null`,
		Title	$title = `null`
	)

Returns true if this content is not a redirect, and this content's text is countable according to the criteria defined by $wgArticleCountMethod.

Parameters

bool \| null	$hasLinks	If it is known whether this content contains links, provide this information here, to avoid redundant parsing to find out (default: null).
Title \| null	$title	Optional title, defaults to the title from the current main request.

Returns: bool

Definition at line 295 of file WikitextContent.php.

References $title, $wgArticleCountMethod, AbstractContent\getParserOutput(), and AbstractContent\isRedirect().

◆ matchMagicWord()

WikitextContent::matchMagicWord ( MagicWord $word )

This implementation calls $word->match() on the this TextContent object's text.

Parameters

MagicWord $word

Returns: bool

See also: Content::matchMagicWord()

Reimplemented from AbstractContent.

Definition at line 415 of file WikitextContent.php.

References TextContent\getText(), and MagicWord\match().

◆ preloadTransform()

WikitextContent::preloadTransform	(	Title	$title,
		ParserOptions	$popts,
			$params = `[]`
	)

Returns a Content object with preload transformations applied (or this object if no transformations apply).

Parameters

Title	$title
ParserOptions	$popts
array	$params

Returns: Content

Reimplemented from AbstractContent.

Definition at line 184 of file WikitextContent.php.

References $title, and TextContent\getText().

◆ preSaveTransform()

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

Returns a Content object with pre-save transformations applied using Parser::preSaveTransform().

Parameters

Title	$title
User	$user
ParserOptions	$popts

Returns: Content

Reimplemented from TextContent.

Definition at line 155 of file WikitextContent.php.

References $title, and TextContent\getText().

◆ replaceSection()

WikitextContent::replaceSection	(		$sectionId,
		Content	$with,
			$sectionTitle = `''`
	)

Parameters

string \| int \| null \| bool	$sectionId
Content	$with
string	$sectionTitle

Exceptions

MWException

Returns: Content

See also: Content::replaceSection()

Reimplemented from AbstractContent.

Definition at line 89 of file WikitextContent.php.

References TextContent\copy(), AbstractContent\getModel(), Content\getModel(), TextContent\getText(), Content\replaceSection(), and wfMessage().

◆ updateRedirect()

WikitextContent::updateRedirect ( Title $target )

This implementation replaces the first link on the page with the given new target if this Content object is a redirect.

Otherwise, this method returns $this.

Since: 1.21

Parameters

Title $target

Returns: Content

See also: Content::updateRedirect()

Reimplemented from AbstractContent.

Definition at line 269 of file WikitextContent.php.

References Title\getFullText(), and AbstractContent\isRedirect().

Member Data Documentation

◆ $hadSignature

bool WikitextContent::$hadSignature = false

private

Tracks if the parser set the user-signature flag when creating this content, which would make it expire faster in ApiStashEdit.

Definition at line 44 of file WikitextContent.php.

◆ $previousParseStackTrace

string null WikitextContent::$previousParseStackTrace = null

private

Stack trace of the previous parse.

Definition at line 49 of file WikitextContent.php.

◆ $redirectTargetAndText

WikitextContent::$redirectTargetAndText = null

private

Definition at line 38 of file WikitextContent.php.

Referenced by getRedirectTargetAndText().

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

includes/content/WikitextContent.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSectionHeader()

◆ fillParserOutput()

◆ getHtml()

◆ getRedirectTarget()

◆ getRedirectTargetAndText()

◆ getSection()

◆ getTextForSummary()

◆ isCountable()

◆ matchMagicWord()

◆ preloadTransform()

◆ preSaveTransform()

◆ replaceSection()

◆ updateRedirect()

Member Data Documentation

◆ $hadSignature

◆ $previousParseStackTrace

◆ $redirectTargetAndText