MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
StripState Class Reference
Parser

Public Member Functions

 __construct (Parser $parser=null, $options=[])
 
 addGeneral ( $marker, $value)
 
 addNoWiki ( $marker, $value)
 Add a nowiki strip item.
 
 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)
 
 unstripBoth ( $text)
 
 unstripGeneral ( $text)
 
 unstripNoWiki ( $text)
 

Protected Member Functions

 addItem ( $type, $marker, $value)
 
 unstripType ( $type, $text)
 

Protected Attributes

 $circularRefGuard
 
 $data
 
 $depth = 0
 
 $depthLimit = 20
 
 $expandSize = 0
 
 $highestDepth = 0
 
 $parser
 
 $regex
 
 $sizeLimit = 5_000_000
 

Detailed Description

Todo
document, briefly.
Stability: newable

Definition at line 31 of file StripState.php.

Constructor & Destructor Documentation

◆ __construct()

StripState::__construct ( Parser $parser = null,
$options = [] )
Stability: stable
to call
Parameters
Parser | null$parser
array$options

Definition at line 51 of file StripState.php.

References $parser.

Member Function Documentation

◆ addGeneral()

StripState::addGeneral ( $marker,
$value )
Parameters
string$marker
string | Closure$value

Definition at line 81 of file StripState.php.

References addItem().

◆ addItem()

StripState::addItem ( $type,
$marker,
$value )
protected
Parameters
string$type
string$marker
string | Closure$value

Definition at line 93 of file StripState.php.

Referenced by addGeneral(), and addNoWiki().

◆ addNoWiki()

StripState::addNoWiki ( $marker,
$value )

Add a nowiki strip item.

Parameters
string$marker
string | Closure$value

Definition at line 73 of file StripState.php.

References addItem().

◆ getLimitReport()

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 245 of file StripState.php.

◆ killMarkers()

StripState::killMarkers ( $text)

Remove any strip markers found in the given text.

Parameters
string$text
Returns
string

Definition at line 268 of file StripState.php.

◆ replaceNoWikis()

StripState::replaceNoWikis ( string $text,
callable $callback )
Parameters
string$text
callable$callback
Returns
string

Definition at line 122 of file StripState.php.

◆ unstripBoth()

StripState::unstripBoth ( $text)
Parameters
string$text
Returns
mixed

Definition at line 154 of file StripState.php.

◆ unstripGeneral()

StripState::unstripGeneral ( $text)
Parameters
string$text
Returns
mixed

Definition at line 105 of file StripState.php.

References unstripType().

◆ unstripNoWiki()

StripState::unstripNoWiki ( $text)
Parameters
string$text
Returns
mixed

Definition at line 113 of file StripState.php.

References unstripType().

◆ unstripType()

StripState::unstripType ( $type,
$text )
protected
Parameters
string$type
string$text
Returns
mixed

Definition at line 165 of file StripState.php.

Referenced by unstripGeneral(), and unstripNoWiki().

Member Data Documentation

◆ $circularRefGuard

StripState::$circularRefGuard
protected

Definition at line 37 of file StripState.php.

◆ $data

StripState::$data
protected

Definition at line 32 of file StripState.php.

◆ $depth

StripState::$depth = 0
protected

Definition at line 38 of file StripState.php.

◆ $depthLimit

StripState::$depthLimit = 20
protected

Definition at line 42 of file StripState.php.

◆ $expandSize

StripState::$expandSize = 0
protected

Definition at line 40 of file StripState.php.

◆ $highestDepth

StripState::$highestDepth = 0
protected

Definition at line 39 of file StripState.php.

◆ $parser

StripState::$parser
protected

Definition at line 35 of file StripState.php.

Referenced by __construct().

◆ $regex

StripState::$regex
protected

Definition at line 33 of file StripState.php.

◆ $sizeLimit

StripState::$sizeLimit = 5_000_000
protected

Definition at line 43 of file StripState.php.

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