HeadingParser
extends AbstractBlockContinueParser
in package
implements
BlockContinueParserWithInlinesInterface
FinalYes
Base class for a block parser
Slightly more convenient to extend from vs. implementing the interface
Table of Contents
Interfaces
- BlockContinueParserWithInlinesInterface
- Interface for a block continuation parser
Properties
Methods
- __construct() : mixed
- addLine() : void
- Add the given line of text to the current block
- canContain() : bool
- Determine whether the current block being parsed can contain the given child block
- canHaveLazyContinuationLines() : bool
- Return whether we are interested in possibly lazily parsing any subsequent lines
- closeBlock() : void
- Close and finalize the current block
- getBlock() : Heading
- Return the current block being parsed by this parser
- isContainer() : bool
- Return whether we are parsing a container block
- parseInlines() : void
- Parse any inlines inside of the current block
- tryContinue() : BlockContinue|null
- Attempt to parse the given line
Properties
$block
private
Heading
$block
Tags
$content
private
string
$content
Methods
__construct()
public
__construct(int $level, string $content) : mixed
Parameters
- $level : int
- $content : string
addLine()
Add the given line of text to the current block
public
addLine(string $line) : void
Parameters
- $line : string
canContain()
Determine whether the current block being parsed can contain the given child block
public
canContain(AbstractBlock $childBlock) : bool
Parameters
- $childBlock : AbstractBlock
Return values
boolcanHaveLazyContinuationLines()
Return whether we are interested in possibly lazily parsing any subsequent lines
public
canHaveLazyContinuationLines() : bool
Return values
boolcloseBlock()
Close and finalize the current block
public
closeBlock() : void
getBlock()
Return the current block being parsed by this parser
public
getBlock() : Heading
Return values
HeadingisContainer()
Return whether we are parsing a container block
public
isContainer() : bool
Return values
boolparseInlines()
Parse any inlines inside of the current block
public
parseInlines(InlineParserEngineInterface $inlineParser) : void
Parameters
- $inlineParser : InlineParserEngineInterface
tryContinue()
Attempt to parse the given line
public
tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser) : BlockContinue|null
Parameters
- $cursor : Cursor
- $activeBlockParser : BlockContinueParserInterface