GuideSetDescriptor
extends DocumentationSetDescriptor
in package
FinalYes
Table of Contents
Properties
- $description : DescriptionDescriptor|null
- $name : string
- $outputLocation : string
- $source : Source
- $documents : Collection<string|int, DocumentDescriptor>
- $files : Collection<string|int, FileInterface>
- $indexes : Collection<string|int, Collection<string|int, ElementInterface>>
- $initialHeaderLevel : int
- $inputFormat : string
- $outputFormat : string
- $projectNode : ProjectNode
- $tocs : Collection<string|int, TocDescriptor>
Methods
- __construct() : mixed
- addDocument() : void
- addTableOfContents() : void
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getDocuments() : Collection<string|int, DocumentDescriptor>
- getFiles() : Collection<string|int, FileInterface>
- Returns the list of files that is in this documentation set.
- getGuidesProjectNode() : ProjectNode
- getIndex() : Collection<string|int, ElementInterface>
- Returns an index with the given name.
- getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
- Returns all indexes in this documentation set.
- getInitialHeaderLevel() : int
- getInputFormat() : string
- getName() : string
- Returns the name for this element.
- getOutputFormat() : string
- getOutputLocation() : string
- getSource() : Source
- Returns the source location for this set of documentation.
- getTableOfContents() : Collection<string|int, TocDescriptor>
- setDescription() : void
- Sets a description or none to inherit from a parent.
- setFiles() : void
- Sets the list of files that is in this documentation set.
- setIndexes() : void
- Sets all indexes for this documentation set.
Properties
$description
protected
DescriptionDescriptor|null
$description
= null
$name
protected
string
$name
= ''
$outputLocation
protected
string
$outputLocation
= '.'
$source
protected
Source
$source
$documents read-only
private
Collection<string|int, DocumentDescriptor>
$documents
$files
private
Collection<string|int, FileInterface>
$files
$indexes
private
Collection<string|int, Collection<string|int, ElementInterface>>
$indexes
$initialHeaderLevel read-only
private
int
$initialHeaderLevel
= 1
$inputFormat read-only
private
string
$inputFormat
$outputFormat read-only
private
string
$outputFormat
= 'html'
$projectNode read-only
private
ProjectNode
$projectNode
$tocs read-only
private
Collection<string|int, TocDescriptor>
$tocs
Methods
__construct()
public
__construct(string $name, Source $source, string $outputLocation, string $inputFormat, ProjectNode $projectNode[, string $outputFormat = 'html' ][, int $initialHeaderLevel = 1 ]) : mixed
Parameters
- $name : string
- $source : Source
- $outputLocation : string
- $inputFormat : string
- $projectNode : ProjectNode
- $outputFormat : string = 'html'
- $initialHeaderLevel : int = 1
addDocument()
public
addDocument(string $file, DocumentDescriptor $documentDescriptor) : void
Parameters
- $file : string
- $documentDescriptor : DocumentDescriptor
addTableOfContents()
public
addTableOfContents(TocDescriptor $descriptor) : void
Parameters
- $descriptor : TocDescriptor
getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetDocuments()
public
getDocuments() : Collection<string|int, DocumentDescriptor>
Return values
Collection<string|int, DocumentDescriptor>getFiles()
Returns the list of files that is in this documentation set.
public
getFiles() : Collection<string|int, FileInterface>
Return values
Collection<string|int, FileInterface>getGuidesProjectNode()
public
getGuidesProjectNode() : ProjectNode
Return values
ProjectNodegetIndex()
Returns an index with the given name.
public
getIndex(string $name) : Collection<string|int, ElementInterface>
If the index does not exist yet, it will dynamically be added to the list of indexes.
Parameters
- $name : string
Return values
Collection<string|int, ElementInterface>getIndexes()
Returns all indexes in this documentation set.
public
getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
Tags
Return values
Collection<string|int, Collection<string|int, ElementInterface>>getInitialHeaderLevel()
public
getInitialHeaderLevel() : int
Return values
intgetInputFormat()
public
getInputFormat() : string
Return values
stringgetName()
Returns the name for this element.
public
getName() : string
Return values
stringgetOutputFormat()
public
getOutputFormat() : string
Return values
stringgetOutputLocation()
public
getOutputLocation() : string
Return values
stringgetSource()
Returns the source location for this set of documentation.
public
getSource() : Source
Tags
Return values
SourcegetTableOfContents()
public
getTableOfContents() : Collection<string|int, TocDescriptor>
Return values
Collection<string|int, TocDescriptor>setDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
setFiles()
Sets the list of files that is in this documentation set.
public
setFiles(Collection<string|int, FileInterface> $files) : void
Parameters
- $files : Collection<string|int, FileInterface>
setIndexes()
Sets all indexes for this documentation set.
public
setIndexes(Collection<string|int, Collection<string|int, ElementInterface>> $indexes) : void
An index is a compilation of references to elements, usually constructed in a compiler step, that aids template generation by providing a conveniently assembled list. An example of such an index is the 'marker' index where a list of TODOs and FIXMEs are located in a central location for reporting.
Parameters
- $indexes : Collection<string|int, Collection<string|int, ElementInterface>>