TableOfContents

Extends \ArrayObject

This collection manages which headings were discovered during the discovery phase and stores them as entries.

package

Default

Methods

Returns the list of modules.

getModules() : array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\Module>

offsetGet

offsetGet( $index) 

Arguments

$index

Override offsetSet to force the use of the relative filename.

offsetSet(void $index, \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\File $newval) : void
Throws
\InvalidArgumentException

if something other than a file is provided.

Arguments

$index

void

Properties

Contains the list of modules for this Table of Contents.

modules : array<mixed,\phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents\Module>