NamedPhraseRule
extends ReferenceRule
in package
uses
EmbeddedReferenceParser
FinalYes
Rule to parse for named references
Syntax examples:
Sample reference_
Another example <https://phpdoc.org>_
Tags
Table of Contents
Properties
- $referenceRegex : string
- https://regex101.com/r/KadqKx/1
Methods
- applies() : bool
- apply() : InlineNode|null
- getPriority() : int
- createReference() : AbstractLinkInlineNode
- rollback() : void
- extractEmbeddedReference() : ReferenceData
Properties
$referenceRegex
https://regex101.com/r/KadqKx/1
private
string
$referenceRegex
= '/^(.*?)(<([^<]+)>)?$/s'
Methods
applies()
public
applies(InlineLexer $lexer) : bool
Parameters
- $lexer : InlineLexer
Return values
boolapply()
public
apply(BlockContext $blockContext, InlineLexer $lexer) : InlineNode|null
Parameters
- $blockContext : BlockContext
- $lexer : InlineLexer
Return values
InlineNode|nullgetPriority()
public
getPriority() : int
Return values
intcreateReference()
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
extractEmbeddedReference()
private
extractEmbeddedReference(string $text) : ReferenceData
Parameters
- $text : string