NamedReferenceRule
extends ReferenceRule
in package
implements
CachableInlineRule
FinalYes
Rule to parse for simple named references
Syntax examples:
Sample reference_
Tags
Table of Contents
Interfaces
Methods
- applies() : bool
- apply() : InlineNodeInterface|null
- getPriority() : int
- getToken() : InlineLexer::*
- createReference() : AbstractLinkInlineNode
- rollback() : void
Methods
applies()
public
applies(InlineLexer $lexer) : bool
Parameters
- $lexer : InlineLexer
Return values
boolapply()
public
apply(BlockContext $blockContext, InlineLexer $lexer) : InlineNodeInterface|null
Parameters
- $blockContext : BlockContext
- $lexer : InlineLexer
Return values
InlineNodeInterface|nullgetPriority()
public
getPriority() : int
Return values
intgetToken()
public
getToken() : InlineLexer::*
Return values
InlineLexer::*createReference()
protected
createReference(BlockContext $blockContext, string $reference[, string|null $text = null ][, bool $registerLink = true ]) : AbstractLinkInlineNode
Parameters
- $blockContext : BlockContext
- $reference : string
- $text : string|null = null
- $registerLink : bool = true
Return values
AbstractLinkInlineNoderollback()
protected
rollback(InlineLexer $lexer, int $position) : void
Parameters
- $lexer : InlineLexer
- $position : int