GuideSetBuilder
in package
implements
DocumentationSetBuilder
FinalYes
Table of Contents
Interfaces
Properties
Methods
- __construct() : mixed
- build() : void
- supports() : bool
- createGuideEntries() : void
Properties
$router read-only
private
Router
$router
Methods
__construct()
public
__construct(Router $router) : mixed
Parameters
- $router : Router
build()
public
build(DocumentationSetDescriptor $documentationSet) : void
Parameters
- $documentationSet : DocumentationSetDescriptor
supports()
public
supports(DocumentationSetDescriptor $documentationSet) : bool
Parameters
- $documentationSet : DocumentationSetDescriptor
Return values
boolcreateGuideEntries()
private
createGuideEntries(DocumentDescriptor $documentDescriptor, DocumentEntryNode|SectionEntryNode $metaEntry, GuideSetDescriptor $guideSetDescriptor, TocDescriptor $guideToc[, Entry|null $parent = null ]) : void
Parameters
- $documentDescriptor : DocumentDescriptor
- $metaEntry : DocumentEntryNode|SectionEntryNode
- $guideSetDescriptor : GuideSetDescriptor
- $guideToc : TocDescriptor
- $parent : Entry|null = null