phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\DescriptorGuideSetDescriptor

Summary

Methods
Properties
Constants
__construct()
getName()
addTableOfContents()
getTableOfContents()
getSource()
getOutputLocation()
setFiles()
getFiles()
setIndexes()
getIndexes()
getIndex()
addDocument()
setMetas()
getMetas()
getInputFormat()
getOutputFormat()
getInitialHeaderLevel()
getDocuments()
No public properties found
No constants found
No protected methods found
$name
$source
$outputLocation
N/A
No private methods found
$tocs
$files
$indexes
$inputFormat
$outputFormat
$documents
$initialHeaderLevel
$metas
N/A

Properties

$name

$name : string

Type

string

$source

$source : \phpDocumentor\Configuration\Source

Type

\phpDocumentor\Configuration\Source

$outputLocation

$outputLocation : string

Type

string

$tocs

$tocs : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor> —

$files

$files : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> —

$indexes

$indexes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> —

$inputFormat

$inputFormat : string

Type

string —

$outputFormat

$outputFormat : string

Type

string —

$documents

$documents : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor> —

$initialHeaderLevel

$initialHeaderLevel : int

Type

int —

$metas

$metas : \phpDocumentor\Guides\Metas

Type

\phpDocumentor\Guides\Metas

Methods

__construct()

__construct(string  $name, \phpDocumentor\Configuration\Source  $source, string  $outputLocation, string  $inputFormat, string  $outputFormat = 'html', int  $initialHeaderLevel = 1) : mixed

Parameters

string $name
\phpDocumentor\Configuration\Source $source
string $outputLocation
string $inputFormat
string $outputFormat
int $initialHeaderLevel

Returns

mixed —

getName()

getName() : string

Returns

string —

addTableOfContents()

addTableOfContents(\phpDocumentor\Descriptor\TocDescriptor  $descriptor) : void

Parameters

\phpDocumentor\Descriptor\TocDescriptor $descriptor

getTableOfContents()

getTableOfContents() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TocDescriptor> —

getSource()

getSource() : \phpDocumentor\Configuration\Source

Returns the source location for this set of documentation.

Returns

\phpDocumentor\Configuration\Source —

getOutputLocation()

getOutputLocation() : string

Returns

string —

setFiles()

setFiles(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>  $files) : void

Sets the list of files that is in this documentation set.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> $files

getFiles()

getFiles() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface>

Returns the list of files that is in this documentation set.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FileInterface> —

setIndexes()

setIndexes(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>  $indexes) : void

Sets all indexes for this documentation set.

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

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> $indexes

getIndexes()

getIndexes() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>>

Returns all indexes in this documentation set.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>> —

getIndex()

getIndex(string  $name) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface>

Returns an index with the given name.

If the index does not exist yet, it will dynamically be added to the list of indexes.

Parameters

string $name

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ElementInterface> —

addDocument()

addDocument(string  $file, \phpDocumentor\Descriptor\DocumentDescriptor  $documentDescriptor) : void

Parameters

string $file
\phpDocumentor\Descriptor\DocumentDescriptor $documentDescriptor

setMetas()

setMetas(\phpDocumentor\Guides\Metas  $metas) : void

Parameters

\phpDocumentor\Guides\Metas $metas

getMetas()

getMetas() : \phpDocumentor\Guides\Metas

Returns

\phpDocumentor\Guides\Metas —

getInputFormat()

getInputFormat() : string

Returns

string —

getOutputFormat()

getOutputFormat() : string

Returns

string —

getInitialHeaderLevel()

getInitialHeaderLevel() : int

Returns

int —

getDocuments()

getDocuments() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor> —