Collaboration diagram for MediaWiki\Parser\StripState:

[legend]

Public Member Functions
	__construct (?Parser $parser=null, $options=[])

	addExtTag ( $marker, $value, $frame)

	addGeneral ( $marker, $value)

	addNoWiki ( $marker, $value, ?string $extra=null)
	Add a nowiki strip item.

	addParsoidOpaque ( $marker, PFragment $extra)

	getLimitReport ()
	Get an array of parameters to pass to ParserOutput::setLimitReportData()

	killMarkers ( $text)
	Remove any strip markers found in the given text.

	replaceNoWikis (string $text, callable $callback)

	split (string $text, bool $keepExtTag=false)
	Split the given text by strip markers, returning an array of [ 'type' => ..., 'content' => ... ] elements.

	unstripBoth ( $text)

	unstripGeneral ( $text)

	unstripNoWiki ( $text)

	unstripParsoid (string $text, $extApi)

Protected Member Functions
	addItem ( $type, $marker, $value, $extra=null)

	unstripType ( $type, $text, ?ParsoidExtensionAPI $extApi=null)

Protected Attributes
array	$circularRefGuard

array[]	$data

int	$depth = 0

int	$depthLimit = 20

int	$expandSize = 0

array[]	$extra

int	$highestDepth = 0

Parser	$parser

string	$regex

int	$sizeLimit = 5_000_000

Detailed Description

Todo: document, briefly.

Stability: newable

Definition at line 22 of file StripState.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Parser\StripState::__construct	(	?Parser	$parser = null,
			$options = [] )

Stability: stable: to call

Parameters

Parser \| null	$parser
array	$options

Definition at line 52 of file StripState.php.

References MediaWiki\Parser\StripState\$parser, and MediaWiki\Parser\Parser\MARKER_PREFIX.

Member Function Documentation

◆ addExtTag()

MediaWiki\Parser\StripState::addExtTag	(	$marker,
		$value,
		$frame )

Parameters

string	$marker
string \| Closure	$value
PPFrame	$frame

Since: 1.44

Access: internal: Parsoid use only.

Definition at line 98 of file StripState.php.

References MediaWiki\Parser\StripState\addItem().

◆ addGeneral()

MediaWiki\Parser\StripState::addGeneral	(		$marker,
			$value )

Parameters

string	$marker
string \| Closure	$value

Definition at line 87 of file StripState.php.

References MediaWiki\Parser\StripState\addItem().

◆ addItem()

MediaWiki\Parser\StripState::addItem	(	$type,
		$marker,
		$value,
		$extra = null )

protected

Parameters

string	$type
string	$marker
string \| Closure	$value
string \| PFragment \| PPFrame \| null	$extra

Definition at line 121 of file StripState.php.

References MediaWiki\Parser\StripState\$extra.

Referenced by MediaWiki\Parser\StripState\addExtTag(), MediaWiki\Parser\StripState\addGeneral(), MediaWiki\Parser\StripState\addNoWiki(), and MediaWiki\Parser\StripState\addParsoidOpaque().

◆ addNoWiki()

MediaWiki\Parser\StripState::addNoWiki	(		$marker,
			$value,
		?string	$extra = null )

Add a nowiki strip item.

Parameters

string	$marker
string \| Closure	$value
?string	$extra	Used to distinguish items added by <nowiki> from items added by other mechanisms.

Definition at line 79 of file StripState.php.

References MediaWiki\Parser\StripState\$extra, and MediaWiki\Parser\StripState\addItem().

◆ addParsoidOpaque()

MediaWiki\Parser\StripState::addParsoidOpaque	(		$marker,
		PFragment	$extra )

Parameters

string	$marker
PFragment	$extra

Since: 1.44

Access: internal: Parsoid use only.

Definition at line 108 of file StripState.php.

References MediaWiki\Parser\StripState\$extra, and MediaWiki\Parser\StripState\addItem().

◆ getLimitReport()

MediaWiki\Parser\StripState::getLimitReport ( )

Get an array of parameters to pass to ParserOutput::setLimitReportData()

Access: internal: Should only be called by Parser

Returns: array

Definition at line 390 of file StripState.php.

◆ killMarkers()

MediaWiki\Parser\StripState::killMarkers ( $text )

Remove any strip markers found in the given text.

Parameters

string $text

Returns: string

Definition at line 413 of file StripState.php.

◆ replaceNoWikis()

MediaWiki\Parser\StripState::replaceNoWikis	(	string	$text,
		callable	$callback )

Parameters

string	$text
callable	$callback

Returns: string

Stability: unstable: Temporarily used by Scribunto/SyntaxHighlight

Definition at line 163 of file StripState.php.

◆ split()

MediaWiki\Parser\StripState::split	(	string	$text,
		bool	$keepExtTag = false )

Split the given text by strip markers, returning an array of [ 'type' => ..., 'content' => ... ] elements.

The type property is:

'string' for plain strings and 'exttag' strip markers
otherwise, name of the strip marker that generated the 'content' value
Returns
array<string|array{type:string,content:string,extra?:mixed}>

Definition at line 200 of file StripState.php.

◆ unstripBoth()

MediaWiki\Parser\StripState::unstripBoth ( $text )

Parameters

string $text

Returns: mixed

Definition at line 293 of file StripState.php.

◆ unstripGeneral()

MediaWiki\Parser\StripState::unstripGeneral ( $text )

Parameters

string $text

Returns: mixed

Definition at line 136 of file StripState.php.

References MediaWiki\Parser\StripState\unstripType().

◆ unstripNoWiki()

MediaWiki\Parser\StripState::unstripNoWiki ( $text )

Parameters

string $text

Returns: mixed

Definition at line 144 of file StripState.php.

References MediaWiki\Parser\StripState\unstripType().

◆ unstripParsoid()

MediaWiki\Parser\StripState::unstripParsoid	(	string	$text,
			$extApi )

Parameters

string	$text
mixed	$extApi

Returns: mixed

Definition at line 153 of file StripState.php.

References MediaWiki\Parser\StripState\unstripType().

◆ unstripType()

MediaWiki\Parser\StripState::unstripType	(		$type,
			$text,
		?ParsoidExtensionAPI	$extApi = null )

protected

Parameters

string	$type
string	$text
?ParsoidExtensionAPI	$extApi

Returns: mixed

Definition at line 305 of file StripState.php.

Referenced by MediaWiki\Parser\StripState\unstripGeneral(), MediaWiki\Parser\StripState\unstripNoWiki(), and MediaWiki\Parser\StripState\unstripParsoid().

Member Data Documentation

◆ $circularRefGuard

array MediaWiki\Parser\StripState::$circularRefGuard

protected

Definition at line 33 of file StripState.php.

◆ $data

array [] MediaWiki\Parser\StripState::$data

protected

Definition at line 24 of file StripState.php.

◆ $depth

int MediaWiki\Parser\StripState::$depth = 0

protected

Definition at line 35 of file StripState.php.

◆ $depthLimit

int MediaWiki\Parser\StripState::$depthLimit = 20

protected

Definition at line 42 of file StripState.php.

◆ $expandSize

int MediaWiki\Parser\StripState::$expandSize = 0

protected

Definition at line 39 of file StripState.php.

◆ $extra

array [] MediaWiki\Parser\StripState::$extra

protected

Definition at line 26 of file StripState.php.

Referenced by MediaWiki\Parser\StripState\addItem(), MediaWiki\Parser\StripState\addNoWiki(), and MediaWiki\Parser\StripState\addParsoidOpaque().

◆ $highestDepth

int MediaWiki\Parser\StripState::$highestDepth = 0

protected

Definition at line 37 of file StripState.php.

◆ $parser

Parser MediaWiki\Parser\StripState::$parser

protected

Definition at line 30 of file StripState.php.

Referenced by MediaWiki\Parser\StripState\__construct().

◆ $regex

string MediaWiki\Parser\StripState::$regex

protected

Definition at line 28 of file StripState.php.

◆ $sizeLimit

int MediaWiki\Parser\StripState::$sizeLimit = 5_000_000

protected

Definition at line 44 of file StripState.php.

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

includes/Parser/StripState.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addExtTag()

◆ addGeneral()

◆ addItem()

◆ addNoWiki()

◆ addParsoidOpaque()

◆ getLimitReport()

◆ killMarkers()

◆ replaceNoWikis()

◆ split()

◆ unstripBoth()

◆ unstripGeneral()

◆ unstripNoWiki()

◆ unstripParsoid()

◆ unstripType()

Member Data Documentation

◆ $circularRefGuard

◆ $data

◆ $depth

◆ $depthLimit

◆ $expandSize

◆ $extra

◆ $highestDepth

◆ $parser

◆ $regex

◆ $sizeLimit