Class allowing to explore the structure of parsed wikitext. More...

Public Member Functions
	__construct (ParserOutput $parserOutput)

	getAuxiliaryText ()

	getDefaultSort ()
	Get the "defaultsort" property.

	getMainText ()

	getOpeningText ()

	headings ()
	Gets headings from the page.

Static Public Member Functions
static	parseSettingsInMessage ( $message)
	Parse a message content into an array.

Detailed Description

Class allowing to explore the structure of parsed wikitext.

Definition at line 13 of file WikiTextStructure.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Content\WikiTextStructure::__construct ( ParserOutput $parserOutput )

Definition at line 61 of file WikiTextStructure.php.

Member Function Documentation

◆ getAuxiliaryText()

MediaWiki\Content\WikiTextStructure::getAuxiliaryText ( )

Returns: string[]

Definition at line 250 of file WikiTextStructure.php.

◆ getDefaultSort()

MediaWiki\Content\WikiTextStructure::getDefaultSort ( )

Get the "defaultsort" property.

Returns: string|null

Definition at line 261 of file WikiTextStructure.php.

◆ getMainText()

MediaWiki\Content\WikiTextStructure::getMainText ( )

Returns: string

Definition at line 241 of file WikiTextStructure.php.

◆ getOpeningText()

MediaWiki\Content\WikiTextStructure::getOpeningText ( )

Returns: string|null

Definition at line 232 of file WikiTextStructure.php.

◆ headings()

MediaWiki\Content\WikiTextStructure::headings ( )

Gets headings from the page.

Returns: string[] First strip out things that look like references. We can't use HTML filtering because the references come back as ^{tags without a class. To keep from breaking stuff like ==Applicability of the strict mass–energy equivalence formula, ''E'' = ''mc''²== we don't remove the whole ^tag.}

We also don't want to strip the ^{tag and remove everything that looks like [2] because, I don't know, maybe there is a band named Word [2] Foo r something. Whatever.}

^{^{^{So we only strip things that look like ^{tags wrapping a reference. And since the data looks like: Reference in heading ^[1]^[2] we can not really use HtmlFormatter as we have no suitable selector.}}}}

Definition at line 82 of file WikiTextStructure.php.

◆ parseSettingsInMessage()

static MediaWiki\Content\WikiTextStructure::parseSettingsInMessage ( $message )

static

Parse a message content into an array.

This function is generally used to parse settings stored as i18n messages (see search-ignored-headings).

Parameters

string $message

Returns: string[]

Definition at line 120 of file WikiTextStructure.php.

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

includes/Content/WikiTextStructure.php

Public Member Functions

Static Public Member Functions