Documentation

TableOfContentsGenerator
in package
implements TableOfContentsGeneratorInterface

Interfaces, Classes and Traits

TableOfContentsGeneratorInterface

Table of Contents

NORMALIZE_DISABLED  = 'as-is'
NORMALIZE_FLAT  = 'flat'
NORMALIZE_RELATIVE  = 'relative'
STYLE_BULLET  = LeagueCommonMarkBlockElementListBlock::TYPE_BULLET
STYLE_ORDERED  = LeagueCommonMarkBlockElementListBlock::TYPE_ORDERED
$maxHeadingLevel  : int
$minHeadingLevel  : int
$normalizationStrategy  : string
$style  : string
__construct()  : mixed
generate()  : TableOfContents|null
createToc()  : TableOfContents
getHeadingLinks()  : iteratable<string|int, HeadingPermalink>
getHeadingText()  : string
getNormalizer()  : NormalizerStrategyInterface

Constants

Properties

Methods

__construct()

public __construct(string $style, string $normalizationStrategy, int $minHeadingLevel, int $maxHeadingLevel) : mixed
Parameters
$style : string
$normalizationStrategy : string
$minHeadingLevel : int
$maxHeadingLevel : int
Return values
mixed

Search results