\phpDocumentor\DescriptorApiSetDescriptor

Summary

Methods
Properties
Constants
__construct()
getName()
addTableOfContents()
getTableOfContents()
getSource()
getOutputLocation()
setFiles()
getFiles()
setIndexes()
getIndexes()
getIndex()
getSettings()
findElement()
No public properties found
No constants found
No protected methods found
$name
$source
$outputLocation
N/A
No private methods found
$tocs
$files
$indexes
$apiSpecification
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>> —

$apiSpecification

$apiSpecification : \phpDocumentor\Configuration\ApiSpecification

Type

\phpDocumentor\Configuration\ApiSpecification

Methods

__construct()

__construct(string  $name, \phpDocumentor\Configuration\Source  $source, string  $outputLocation, \phpDocumentor\Configuration\ApiSpecification  $apiSpecification) : mixed

Parameters

string $name
\phpDocumentor\Configuration\Source $source
string $outputLocation
\phpDocumentor\Configuration\ApiSpecification $apiSpecification

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> —

getSettings()

getSettings() : \phpDocumentor\Configuration\ApiSpecification

Returns

\phpDocumentor\Configuration\ApiSpecification —

findElement()

findElement(\phpDocumentor\Reflection\Fqsen  $fqsen) : ?\phpDocumentor\Descriptor\Interfaces\ElementInterface

Finds a structural element with the given FQSEN in this Documentation Set, or returns null when it could not be found.

Parameters

\phpDocumentor\Reflection\Fqsen $fqsen

Returns

?\phpDocumentor\Descriptor\Interfaces\ElementInterface —