TableOfContentsBuilder
in package
implements
ConfigurationAwareInterface
FinalYes
Table of Contents
Interfaces
- ConfigurationAwareInterface
- Implement this class to facilitate setter injection of the configuration where needed
Constants
- POSITION_BEFORE_HEADINGS = 'before-headings'
- POSITION_PLACEHOLDER = 'placeholder'
- POSITION_TOP = 'top'
Properties
Methods
- onDocumentParsed() : void
- setConfiguration() : void
- insertBeforeFirstLinkedHeading() : void
- replacePlaceholders() : void
Constants
POSITION_BEFORE_HEADINGS
public
mixed
POSITION_BEFORE_HEADINGS
= 'before-headings'
POSITION_PLACEHOLDER
public
mixed
POSITION_PLACEHOLDER
= 'placeholder'
POSITION_TOP
public
mixed
POSITION_TOP
= 'top'
Properties
$config
private
ConfigurationInterface
$config
Tags
Methods
onDocumentParsed()
public
onDocumentParsed(DocumentParsedEvent $event) : void
Parameters
- $event : DocumentParsedEvent
setConfiguration()
public
setConfiguration(ConfigurationInterface $configuration) : void
Parameters
- $configuration : ConfigurationInterface
insertBeforeFirstLinkedHeading()
private
insertBeforeFirstLinkedHeading(Document $document, TableOfContents $toc) : void
Parameters
- $document : Document
- $toc : TableOfContents
replacePlaceholders()
private
replacePlaceholders(Document $document, TableOfContents $toc) : void
Parameters
- $document : Document
- $toc : TableOfContents