MediaWiki  master
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | 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. More...
 
 getLimitReport ()
 Get an array of parameters to pass to ParserOutput::setLimitReportData() More...
 
 killMarkers ( $text)
 Remove any strip markers found in the given text. More...
 
 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 = 5000000
 

Private Member Functions

 getLimitationWarning ( $type, $max='')
 Get warning HTML and register a limitation warning with the parser. More...
 
 getWarning ( $message, $max='')
 Get warning HTML. More...
 

Detailed Description

Todo:
document, briefly.
Stability: newable

Definition at line 29 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 49 of file StripState.php.

References $parser, and Parser\MARKER_PREFIX.

Member Function Documentation

◆ addGeneral()

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

Definition at line 79 of file StripState.php.

References addItem().

◆ addItem()

StripState::addItem (   $type,
  $marker,
  $value 
)
protected
Exceptions
MWException
Parameters
string$type
string$marker
string$value

Definition at line 89 of file StripState.php.

References $type.

Referenced by addGeneral(), and addNoWiki().

◆ addNoWiki()

StripState::addNoWiki (   $marker,
  $value 
)

Add a nowiki strip item.

Parameters
string$marker
string$value

Definition at line 71 of file StripState.php.

References addItem().

◆ getLimitationWarning()

StripState::getLimitationWarning (   $type,
  $max = '' 
)
private

Get warning HTML and register a limitation warning with the parser.

Parameters
string$type
int | string$max
Returns
string

Definition at line 181 of file StripState.php.

References $type, and getWarning().

Referenced by unstripType().

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

References $depthLimit, $expandSize, $highestDepth, and $sizeLimit.

◆ getWarning()

StripState::getWarning (   $message,
  $max = '' 
)
private

Get warning HTML.

Parameters
string$message
int | string$max
Returns
string

Definition at line 195 of file StripState.php.

References wfMessage().

Referenced by getLimitationWarning(), and unstripType().

◆ killMarkers()

StripState::killMarkers (   $text)

Remove any strip markers found in the given text.

Parameters
string$text
Returns
string

Definition at line 231 of file StripState.php.

◆ unstripBoth()

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

Definition at line 117 of file StripState.php.

References unstripType().

◆ unstripGeneral()

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

Definition at line 101 of file StripState.php.

References unstripType().

◆ unstripNoWiki()

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

Definition at line 109 of file StripState.php.

References unstripType().

◆ unstripType()

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

Definition at line 128 of file StripState.php.

References $depth, $type, getLimitationWarning(), and getWarning().

Referenced by unstripBoth(), unstripGeneral(), and unstripNoWiki().

Member Data Documentation

◆ $circularRefGuard

StripState::$circularRefGuard
protected

Definition at line 35 of file StripState.php.

◆ $data

StripState::$data
protected

Definition at line 30 of file StripState.php.

◆ $depth

StripState::$depth = 0
protected

Definition at line 36 of file StripState.php.

Referenced by unstripType().

◆ $depthLimit

StripState::$depthLimit = 20
protected

Definition at line 40 of file StripState.php.

Referenced by getLimitReport().

◆ $expandSize

StripState::$expandSize = 0
protected

Definition at line 38 of file StripState.php.

Referenced by getLimitReport().

◆ $highestDepth

StripState::$highestDepth = 0
protected

Definition at line 37 of file StripState.php.

Referenced by getLimitReport().

◆ $parser

StripState::$parser
protected

Definition at line 33 of file StripState.php.

Referenced by __construct().

◆ $regex

StripState::$regex
protected

Definition at line 31 of file StripState.php.

◆ $sizeLimit

StripState::$sizeLimit = 5000000
protected

Definition at line 41 of file StripState.php.

Referenced by getLimitReport().

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