ApiSetDescriptor extends DocumentationSetDescriptor uses HasPackage, HasNamespace
Table of Contents
Properties
- $description : DescriptionDescriptor|null
- $name : string
- $namespace : NamespaceInterface|string
- $outputLocation : string
- $package : PackageInterface|string
- $source : Source
- $apiSpecification : ApiSpecification
Methods
- __construct() : mixed
- addTableOfContents() : void
- findElement() : ElementInterface|null
- Finds a structural element with the given FQSEN in this Documentation Set, or returns null when it could not be found.
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getFiles() : Collection<string|int, FileInterface>
- Returns the list of files that is in this documentation set.
- 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.
- getName() : string
- Returns the name for this element.
- getNamespace() : NamespaceInterface|string
- Returns the namespace for this element (defaults to global "\")
- getOutputLocation() : string
- getPackage() : PackageInterface|null
- Returns the package name for this element.
- getSettings() : ApiSpecification
- 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
= ''
$namespace
protected
NamespaceInterface|string
$namespace
= ''
The namespace for this element
$outputLocation
protected
string
$outputLocation
= '.'
$package
protected
PackageInterface|string
$package
The package with which this element is associated
$source
protected
Source
$source
$apiSpecification read-only
private
ApiSpecification
$apiSpecification
Methods
__construct()
public
__construct(string $name, Source $source, string $outputLocation, ApiSpecification $apiSpecification) : mixed
Parameters
- $name : string
- $source : Source
- $outputLocation : string
- $apiSpecification : ApiSpecification
addTableOfContents()
public
addTableOfContents(TocDescriptor $descriptor) : void
Parameters
- $descriptor : TocDescriptor
findElement()
Finds a structural element with the given FQSEN in this Documentation Set, or returns null when it could not be found.
public
findElement(Fqsen $fqsen) : ElementInterface|null
Parameters
- $fqsen : Fqsen
Return values
ElementInterface|nullgetDescription()
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
DescriptionDescriptorgetFiles()
Returns the list of files that is in this documentation set.
public
getFiles() : Collection<string|int, FileInterface>
Return values
Collection<string|int, FileInterface>getIndex()
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>>getName()
Returns the name for this element.
public
getName() : string
Return values
stringgetNamespace()
Returns the namespace for this element (defaults to global "\")
public
getNamespace() : NamespaceInterface|string
Return values
NamespaceInterface|stringgetOutputLocation()
public
getOutputLocation() : string
Return values
stringgetPackage()
Returns the package name for this element.
public
getPackage() : PackageInterface|null
Return values
PackageInterface|nullgetSettings()
public
getSettings() : ApiSpecification
Return values
ApiSpecificationgetSource()
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>>