TableOfContentsBuilder
in package
implements
ConfigurationAwareInterface
Interfaces, Classes and Traits
- ConfigurationAwareInterface
- Implement this class to inject the configuration where needed
Table of Contents
- NORMALIZE_DISABLED = LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::NORMALIZE_DISABLED
- NORMALIZE_FLAT = LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::NORMALIZE_FLAT
- NORMALIZE_RELATIVE = LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::NORMALIZE_RELATIVE
- POSITION_BEFORE_HEADINGS = 'before-headings'
- POSITION_PLACEHOLDER = 'placeholder'
- POSITION_TOP = 'top'
- STYLE_BULLET = LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::STYLE_BULLET
- STYLE_ORDERED = LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::STYLE_ORDERED
- $config : ConfigurationInterface
- onDocumentParsed() : void
- setConfiguration() : void
- insertBeforeFirstLinkedHeading() : void
- replacePlaceholders() : void
Constants
NORMALIZE_DISABLED
public
mixed
NORMALIZE_DISABLED
= LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::NORMALIZE_DISABLED
Tags
NORMALIZE_FLAT
public
mixed
NORMALIZE_FLAT
= LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::NORMALIZE_FLAT
Tags
NORMALIZE_RELATIVE
public
mixed
NORMALIZE_RELATIVE
= LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::NORMALIZE_RELATIVE
Tags
POSITION_BEFORE_HEADINGS
public
mixed
POSITION_BEFORE_HEADINGS
= 'before-headings'
POSITION_PLACEHOLDER
public
mixed
POSITION_PLACEHOLDER
= 'placeholder'
POSITION_TOP
public
mixed
POSITION_TOP
= 'top'
STYLE_BULLET
public
mixed
STYLE_BULLET
= LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::STYLE_BULLET
Tags
STYLE_ORDERED
public
mixed
STYLE_ORDERED
= LeagueCommonMarkExtensionTableOfContentsTableOfContentsGenerator::STYLE_ORDERED
Tags
Properties
$config
private
ConfigurationInterface
$config
Methods
onDocumentParsed()
public
onDocumentParsed(DocumentParsedEvent $event) : void
Parameters
- $event : DocumentParsedEvent
Return values
void —setConfiguration()
public
setConfiguration(ConfigurationInterface $config) : void
Parameters
- $config : ConfigurationInterface
Return values
void —insertBeforeFirstLinkedHeading()
private
insertBeforeFirstLinkedHeading(Document $document, TableOfContents $toc) : void
Parameters
- $document : Document
- $toc : TableOfContents
Return values
void —replacePlaceholders()
private
replacePlaceholders(Document $document, TableOfContents $toc) : void
Parameters
- $document : Document
- $toc : TableOfContents