TableOfContentsGenerator
in package
implements
TableOfContentsGeneratorInterface
FinalYes
Table of Contents
Interfaces
Constants
- NORMALIZE_DISABLED = 'as-is'
- NORMALIZE_FLAT = 'flat'
- NORMALIZE_RELATIVE = 'relative'
- STYLE_BULLET = \League\CommonMark\Extension\CommonMark\Node\Block\ListBlock::TYPE_BULLET
- STYLE_ORDERED = \League\CommonMark\Extension\CommonMark\Node\Block\ListBlock::TYPE_ORDERED
Properties
- $fragmentPrefix : string
- $maxHeadingLevel : int
- $minHeadingLevel : int
- $normalizationStrategy : string
- $style : string
Methods
- __construct() : mixed
- generate() : TableOfContents|null
- createToc() : TableOfContents
- getHeadingLinks() : iterable<string|int, HeadingPermalink>
- getNormalizer() : NormalizerStrategyInterface
Constants
NORMALIZE_DISABLED
public
mixed
NORMALIZE_DISABLED
= 'as-is'
NORMALIZE_FLAT
public
mixed
NORMALIZE_FLAT
= 'flat'
NORMALIZE_RELATIVE
public
mixed
NORMALIZE_RELATIVE
= 'relative'
STYLE_BULLET
public
mixed
STYLE_BULLET
= \League\CommonMark\Extension\CommonMark\Node\Block\ListBlock::TYPE_BULLET
STYLE_ORDERED
public
mixed
STYLE_ORDERED
= \League\CommonMark\Extension\CommonMark\Node\Block\ListBlock::TYPE_ORDERED
Properties
$fragmentPrefix
private
string
$fragmentPrefix
Tags
$maxHeadingLevel
private
int
$maxHeadingLevel
Tags
$minHeadingLevel
private
int
$minHeadingLevel
Tags
$normalizationStrategy
private
string
$normalizationStrategy
Tags
$style
private
string
$style
Tags
Methods
__construct()
public
__construct(string $style, string $normalizationStrategy, int $minHeadingLevel, int $maxHeadingLevel, string $fragmentPrefix) : mixed
Parameters
- $style : string
- $normalizationStrategy : string
- $minHeadingLevel : int
- $maxHeadingLevel : int
- $fragmentPrefix : string
generate()
public
generate(Document $document) : TableOfContents|null
Parameters
- $document : Document
Return values
TableOfContents|nullcreateToc()
private
createToc(Document $document) : TableOfContents
Parameters
- $document : Document
Return values
TableOfContentsgetHeadingLinks()
private
getHeadingLinks(Document $document) : iterable<string|int, HeadingPermalink>
Parameters
- $document : Document
Return values
iterable<string|int, HeadingPermalink>getNormalizer()
private
getNormalizer(TableOfContents $toc) : NormalizerStrategyInterface
Parameters
- $toc : TableOfContents