VersionDescriptor
in package
implements
CompilableSubject, Descriptor
uses
HasName, HasDescription
FinalYes
Table of Contents
Interfaces
- CompilableSubject
- Descriptor
- Base class for descriptors containing the most used options.
Properties
- $description : DescriptionDescriptor|null
- $name : string
- $documentationSets : Collection
- $number : string
Methods
- __construct() : mixed
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getDocumentationSets() : Collection<string|int, DocumentationSetDescriptor>
- getName() : string
- Returns the name for this element.
- getNumber() : string
- getTableOfContents() : Collection<string|int, TocDescriptor>
- setDescription() : void
- Sets a description or none to inherit from a parent.
Properties
$description
protected
DescriptionDescriptor|null
$description
= null
$name
protected
string
$name
= ''
$documentationSets read-only
private
Collection
$documentationSets
$number read-only
private
string
$number
Methods
__construct()
public
__construct(string $number, Collection<string|int, DocumentationSetDescriptor> $documentationSets) : mixed
Parameters
- $number : string
- $documentationSets : Collection<string|int, DocumentationSetDescriptor>
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
DescriptionDescriptorgetDocumentationSets()
public
getDocumentationSets() : Collection<string|int, DocumentationSetDescriptor>
Return values
Collection<string|int, DocumentationSetDescriptor>getName()
Returns the name for this element.
public
getName() : string
Return values
stringgetNumber()
public
getNumber() : string
Return values
stringgetTableOfContents()
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