TitleRule
in package
implements
Rule
FinalYes
Tags
Table of Contents
Interfaces
Constants
- TITLE_LENGTH_MIN = 2
Properties
- $inlineTokenParser : InlineParser
Methods
- __construct() : mixed
- applies() : bool
- apply() : TNode|null
- Enters this state and loops through all relevant lines until a Node is produced.
- currentLineIsAnOverline() : string
- nextLineIsAnUnderline() : string
Constants
TITLE_LENGTH_MIN
private
mixed
TITLE_LENGTH_MIN
= 2
Properties
$inlineTokenParser read-only
private
InlineParser
$inlineTokenParser
Methods
__construct()
public
__construct(InlineParser $inlineTokenParser) : mixed
Parameters
- $inlineTokenParser : InlineParser
applies()
public
applies(BlockContext $blockContext) : bool
Parameters
- $blockContext : BlockContext
Return values
boolapply()
Enters this state and loops through all relevant lines until a Node is produced.
public
apply(BlockContext $blockContext[, CompoundNode|null $on = null ]) : TNode|null
The opening line is considered relevant and as such is always used (this is found the case in the self::Applies() method, otherwise we wouldn't have been here) but for all subsequent lines we use a Look Ahead to test whether it should be included in the Node.
By using a Look Ahead, we prevent the cursor from advancing; and this caused the cursor to 'rest' on the line that is considered that last relevant line. The document parser will advance the line after successfully parsing this and to send the Parser into a line that belongs to another state.
Parameters
- $blockContext : BlockContext
- $on : CompoundNode|null = null
Return values
TNode|nullcurrentLineIsAnOverline()
private
currentLineIsAnOverline(string $line, string|null $nextLine) : string
Parameters
- $line : string
- $nextLine : string|null
Return values
stringnextLineIsAnUnderline()
private
nextLineIsAnUnderline(string $line, string|null $nextLine) : string
Parameters
- $line : string
- $nextLine : string|null