BaseEntry

The Table of Contents entry provides essential information on the current entry, it's place in the structure and where it points to.

package

Default

Methods

Initializes this entry with the given parent, if available.

__construct(\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null $parent = null) 

Adds a child to the collection of children.

addChild(\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry $entry) : void

Returns a list of entries.

getChildren() : array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry>

Returns the name for this entry.

getName() : string

Response

string

Returns the parent entry for this entry.

getParent() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null

Sets the caption for this entry,

setName(string $name) : void

Arguments

$name

string

Sets the parent entry for this entry.

setParent(\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null $parent) : void
Throws
\InvalidArgumentException

if the given parameter is of an incorrect type.

Arguments

Properties

The parent BaseEntry in the containing module.

parent : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null

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.

var

Type(s)

\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry|null

The child entries that are contained in this entry.

children : array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry>

Any entry may contain any amount of child entries which may either be Headings or Files.

var

Type(s)

array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry>

The heading name, or caption, for this entry.

name : string
var

Type(s)

string