The Table of Contents File describes a file and the headings it contains.
A File may also contain other files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.
$parent : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null
The parent BaseEntry in the containing module.
This property may also contain a null value if this is the top entry in this module. Please note that files are also considered entries.
Please note that a null value is usually reserved to the index file.
$children : array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry>
The child entries that are contained in this entry.
Any entry may contain any amount of child entries which may either be Headings or Files.
__construct(\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null $parent = null)
Initializes this entry with the given parent, if available.
| \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null | $parent |
getParent() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null
Returns the parent entry for this entry.
setParent(\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null $parent) : void
Sets the parent entry for this entry.
| \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null | $parent |
if the given parameter is of an incorrect type.
getChildren() : array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry>
Returns a list of entries.
addChild(\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry $entry) : void
Adds a child to the collection of children.
| \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry | $entry |