TocDescriptor
in package
implements
Descriptor
uses
HasName, HasDescription
FinalYes
Table of Contents
Interfaces
- Descriptor
- Base class for descriptors containing the most used options.
Properties
- $description : DescriptionDescriptor|null
- $name : string
- $count : int
- $entries : Collection<string|int, Entry>
Methods
- __construct() : mixed
- addEntry() : void
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getName() : string
- Returns the name for this element.
- getRoots() : Collection<string|int, Entry>
- setDescription() : void
- Sets a description or none to inherit from a parent.
Properties
$description
protected
DescriptionDescriptor|null
$description
= null
$name
protected
string
$name
= ''
$count
private
int
$count
= 0
$entries read-only
private
Collection<string|int, Entry>
$entries
Methods
__construct()
public
__construct(string $name) : mixed
Parameters
- $name : string
addEntry()
public
addEntry(Entry $entry) : void
Parameters
- $entry : Entry
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
DescriptionDescriptorgetName()
Returns the name for this element.
public
getName() : string
Return values
stringgetRoots()
public
getRoots() : Collection<string|int, Entry>
Return values
Collection<string|int, Entry>setDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null