Content object for wiki text pages. More...

Collaboration diagram for WikitextContent:

[legend]

Public Member Functions
	__construct ( $text)

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

	getContentHandler ()

	getPreSaveTransformFlags ()
	Records flags set by preSaveTransform.

	getRedirectTarget ()
	Implement redirect extraction for wikitext.

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

	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.

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

	setPreSaveTransformFlags (array $flags)
	Records flags set by preSaveTransform.

	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)

	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.

	getDefaultFormat ()

	getModel ()

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

	getSupportedFormats ()

	isEmpty ()

	isRedirect ()

	isSupportedFormat ( $format)

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

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

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

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

	serialize ( $format=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 Member Functions inherited from AbstractContent
	checkFormat ( $format)

	checkModelID ( $modelId)

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

	fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
	Fills the provided ParserOutput with information derived from the content.

	getContentHandlerFactory ()

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.

Stability: newable

Definition at line 40 of file WikitextContent.php.

Constructor & Destructor Documentation

◆ __construct()

WikitextContent::__construct ( $text )

Stability: stable: to call

Parameters

string $text

Reimplemented from AbstractContent.

Definition at line 52 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 134 of file WikitextContent.php.

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

◆ getContentHandler()

WikitextContent::getContentHandler ( )

Since: 1.21

See also: Content::getContentHandler

Returns: ContentHandler

Reimplemented from AbstractContent.

Definition at line 288 of file WikitextContent.php.

References getContentHandler().

Referenced by getContentHandler(), getRedirectTarget(), and getRedirectTargetAndText().

◆ getPreSaveTransformFlags()

WikitextContent::getPreSaveTransformFlags ( )

Records flags set by preSaveTransform.

Access: internal: for use by WikitextContentHandler

Returns: string[]

Definition at line 284 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 166 of file WikitextContent.php.

References getContentHandler().

◆ getRedirectTargetAndText()

WikitextContent::getRedirectTargetAndText ( )

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

Since: 1.23

Deprecated: since 1.41, use WikitextContentHandler::getRedirectTargetAndText

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

Definition at line 150 of file WikitextContent.php.

References $content, getContentHandler(), and wfDeprecated().

◆ getSection()

WikitextContent::getSection ( $sectionId )

Parameters

string | int $sectionId

Returns: Content|false|null

See also: Content::getSection()

Reimplemented from AbstractContent.

Definition at line 63 of file WikitextContent.php.

References TextContent\getText().

◆ getTextForSummary()

WikitextContent::getTextForSummary ( $maxlength = 250 )

Parameters

int $maxlength

Returns: string

Reimplemented from TextContent.

Definition at line 246 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 214 of file WikitextContent.php.

References 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 266 of file WikitextContent.php.

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

◆ replaceSection()

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

Parameters

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

Exceptions

MWException

Returns: Content

See also: Content::replaceSection()

Reimplemented from AbstractContent.

Definition at line 85 of file WikitextContent.php.

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

◆ setPreSaveTransformFlags()

WikitextContent::setPreSaveTransformFlags ( array $flags )

Records flags set by preSaveTransform.

Access: internal: for use by WikitextContentHandler

Parameters

string[] $flags

Definition at line 275 of file WikitextContent.php.

◆ 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 188 of file WikitextContent.php.

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

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

includes/content/WikitextContent.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSectionHeader()

◆ getContentHandler()

◆ getPreSaveTransformFlags()

◆ getRedirectTarget()

◆ getRedirectTargetAndText()

◆ getSection()

◆ getTextForSummary()

◆ isCountable()

◆ matchMagicWord()

◆ replaceSection()

◆ setPreSaveTransformFlags()

◆ updateRedirect()