GlobalMenuPass
in package
implements
CompilerPass
FinalYes
Table of Contents
Interfaces
Properties
Methods
- __construct() : mixed
- getMenuEntriesFromDocumentEntries() : InternalMenuEntryNode[]
- getPriority() : int
- run() : DocumentNode[]
- addSubEntries() : void
- createExternalMenuEntry() : ExternalMenuEntryNode
- createInternalMenuEntry() : InternalMenuEntryNode
- getMenuEntryWithChildren() : MenuEntryNode
- getNavMenuNodeFromDocumentEntries() : NavMenuNode
- getNavMenuNodefromTocNode() : NavMenuNode
Properties
$settingsManager read-only
private
SettingsManager
$settingsManager
Methods
__construct()
public
__construct(SettingsManager $settingsManager) : mixed
Parameters
- $settingsManager : SettingsManager
getMenuEntriesFromDocumentEntries()
public
getMenuEntriesFromDocumentEntries(DocumentEntryNode $rootDocumentEntry) : InternalMenuEntryNode[]
Parameters
- $rootDocumentEntry : DocumentEntryNode
Return values
InternalMenuEntryNode[]getPriority()
public
getPriority() : int
Return values
intrun()
public
run(DocumentNode[] $documents, CompilerContextInterface $compilerContext) : DocumentNode[]
Parameters
- $documents : DocumentNode[]
- $compilerContext : CompilerContextInterface
Return values
DocumentNode[]addSubEntries()
private
addSubEntries(CompilerContextInterface $compilerContext, MenuEntryNode $sectionMenuEntry, EntryNode<string|int, DocumentEntryNode|ExternalEntryNode>|ExternalEntryNode $entryNode, int $currentLevel, int $maxDepth) : void
Parameters
- $compilerContext : CompilerContextInterface
- $sectionMenuEntry : MenuEntryNode
- $entryNode : EntryNode<string|int, DocumentEntryNode|ExternalEntryNode>|ExternalEntryNode
- $currentLevel : int
- $maxDepth : int
createExternalMenuEntry()
private
createExternalMenuEntry(ExternalEntryNode $subEntryNode, int $currentLevel) : ExternalMenuEntryNode
Parameters
- $subEntryNode : ExternalEntryNode
- $currentLevel : int
Return values
ExternalMenuEntryNodecreateInternalMenuEntry()
private
createInternalMenuEntry(DocumentEntryNode $subEntryNode, int $currentLevel) : InternalMenuEntryNode
Parameters
- $subEntryNode : DocumentEntryNode
- $currentLevel : int
Return values
InternalMenuEntryNodegetMenuEntryWithChildren()
private
getMenuEntryWithChildren(CompilerContextInterface $compilerContext, MenuEntryNode $menuEntry) : MenuEntryNode
Parameters
- $compilerContext : CompilerContextInterface
- $menuEntry : MenuEntryNode
Return values
MenuEntryNodegetNavMenuNodeFromDocumentEntries()
private
getNavMenuNodeFromDocumentEntries(CompilerContextInterface $compilerContext) : NavMenuNode
Parameters
- $compilerContext : CompilerContextInterface
Return values
NavMenuNodegetNavMenuNodefromTocNode()
private
getNavMenuNodefromTocNode(CompilerContextInterface $compilerContext, TocNode $tocNode[, string|null $menuType = null ]) : NavMenuNode
Parameters
- $compilerContext : CompilerContextInterface
- $tocNode : TocNode
- $menuType : string|null = null