PHP Class League\CommonMark\Delimiter\DelimiterStack

Show file Open project: colinodell/commonmark-php Class Usage Examples

Protected Properties

Property	Type	Description
$top	Delimiter \| null

Public Methods

Method	Description
findEarliest ( Delimiter $stackBottom = null ) : Delimiter \| null
getTop ( )
iterateByCharacters ( string \| string[] $characters, callable $callback, Delimiter $stackBottom = null )
push ( Delimiter $newDelimiter )
removeAll ( Delimiter $stackBottom = null )
removeDelimiter ( Delimiter $delimiter )
removeEarlierMatches ( string $character )
searchByCharacter ( string \| string[] $characters ) : Delimiter \| null

Protected Methods

Method	Description
findFirstMatchingOpener ( Delimiter $closer, array $openersBottom, Delimiter $stackBottom = null ) : Delimiter \| null
findMatchingOpener ( Delimiter $closer, array $openersBottom, Delimiter $stackBottom = null, boolean &$oddMatch = false ) : Delimiter \| null

Method Details

findEarliest() public method

public findEarliest ( Delimiter $stackBottom = null ) : Delimiter \| null
$stackBottom	Delimiter
return	Delimiter \| null

findFirstMatchingOpener() protected method

Deprecation: Use findMatchingOpener() instead. This method will be removed in the next major release.

protected findFirstMatchingOpener ( Delimiter $closer, array $openersBottom, Delimiter $stackBottom = null ) : Delimiter \| null
$closer	Delimiter
$openersBottom	array
$stackBottom	Delimiter
return	Delimiter \| null

findMatchingOpener() protected method

protected findMatchingOpener ( Delimiter $closer, array $openersBottom, Delimiter $stackBottom = null, boolean &$oddMatch = false ) : Delimiter \| null
$closer	Delimiter
$openersBottom	array
$stackBottom	Delimiter
$oddMatch	boolean
return	Delimiter \| null

getTop() public method

public getTop ( )

iterateByCharacters() public method

public iterateByCharacters ( string \| string[] $characters, callable $callback, Delimiter $stackBottom = null )
$characters	string \| string[]
$callback	callable
$stackBottom	Delimiter

push() public method

public push ( Delimiter $newDelimiter )
$newDelimiter	Delimiter

removeAll() public method

public removeAll ( Delimiter $stackBottom = null )
$stackBottom	Delimiter

removeDelimiter() public method

public removeDelimiter ( Delimiter $delimiter )
$delimiter	Delimiter

removeEarlierMatches() public method

public removeEarlierMatches ( string $character )
$character	string

searchByCharacter() public method

public searchByCharacter ( string \| string[] $characters ) : Delimiter \| null
$characters	string \| string[]
return	Delimiter \| null

Property Details

$top protected property

protected Delimiter,League\CommonMark\Delimiter\|null $top
return	Delimiter \| null