TocDescriptor
in package
implements
Descriptor
Interfaces, Classes and Traits
- Descriptor
- Base class for descriptors containing the most used options.
Table of Contents
- $entries : Collection<string|int, Entry>
- $name : string
- __construct() : mixed
- addEntry() : void
- getDescription() : DescriptionDescriptor|null
- Returns the description for this element.
- getName() : string
- Returns the local name for this element.
- getRoots() : Collection<string|int, Entry>
Properties
$entries
private
Collection<string|int, Entry>
$entries
$name
private
string
$name
Methods
__construct()
public
__construct(string $name) : mixed
Parameters
- $name : string
Return values
mixed —addEntry()
public
addEntry(Entry $entry) : void
Parameters
- $entry : Entry
Return values
void —getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor|null
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptor|null —getName()
Returns the local name for this element.
public
getName() : string
Return values
string —getRoots()
public
getRoots() : Collection<string|int, Entry>