File

Extends \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\BaseEntry

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.

package

Default

Methods

Initializes this entry with the given parent, if available.

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

Adds a child to the collection of children.

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

Returns a list of entries.

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

Returns the name for this file relative to the project root.

getFilename() : string

Response

string

getHash

getHash() 

Returns the name for this entry.

getName() : string
inherited

Response

string

Returns the parent entry for this entry.

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

Sets the name for this file relative to the project root.

setFilename(string $filename) : void

Arguments

$filename

string

Sets the caption for this entry,

setName(string $name) : void
inherited

Arguments

$name

string

Sets the parent entry for this entry.

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

if the given parameter is of an incorrect type.

Arguments

Properties

hash

hash : 

Type(s)

The name for this file relative to the project's root.

filename : string

This name may be used to generate links and to find other file definitions in the file index of the modules.

var

Type(s)

string

The parent BaseEntry in the containing module.

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

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>
inherited

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
inherited
var

Type(s)

string