Index

A

Toc::addConverters() — Method in class Toc

Add converters to the converter array

C

ConverterInterface — Class in namespace Cable8mm\Toc\Contracts
CleanConverter — Class in namespace Cable8mm\Toc\Converters

Clean unused lines from markdown

$ Toc#converters — Property in class Toc

The converter array

D

ConverterInterface::do() — Method in class ConverterInterface

Convertor method to convert a string representation

CleanConverter::do() — Method in class CleanConverter

Clean unused lines from markdown

$ Toc#data — Property in class Toc

The markdown string for the converter

G

ItemInterface::getTitle() — Method in class ItemInterface

Get the title of the navigation item

ItemInterface::getLink() — Method in class ItemInterface

Get the link of the navigation item

ItemInterface::getType() — Method in class ItemInterface

Get the type of the navigation item

ItemInterface::getDepth() — Method in class ItemInterface

Get the depth of the navigation item

Item::getTitle() — Method in class Item

Get the title of the navigation item

Item::getLink() — Method in class Item

Get the link of the navigation item

Item::getType() — Method in class Item

Get the type of the navigation item

Item::getDepth() — Method in class Item

Get the depth of the navigation item

Toc::grouping() — Method in class Toc
Toc::getSectionTitle() — Method in class Toc

Get the section title

Toc::getLines() — Method in class Toc

Get the toc line array from a markdown string

Toc::getLine() — Method in class Toc

Get the toc nth line from a markdown string

MarkdownString::getLink() — Method in class MarkdownString

Get the link from the Markdown string

H

MarkdownString::hasLink() — Method in class MarkdownString

Has the link or not?

I

ItemInterface — Class in namespace Cable8mm\Toc\Contracts
Item — Class in namespace Cable8mm\Toc

The TOC Item class represents

L

$ Toc#lines — Property in class Toc

The line array

M

Toc::mapping() — Method in class Toc

Map lines to Item instance

MarkdownString — Class in namespace Cable8mm\Toc\Types

N

Toc::normalize() — Method in class Toc

Converts markdown string using the converters provided

O

Item::of() — Method in class Item
Factory
Toc::of() — Method in class Toc
Factory

S

$ Toc#sections — Property in class Toc

The section array

T

Item::toHtml() — Method in class Item

Get the HTML of the given markdown string

Toc — Class in namespace Cable8mm\Toc
Toc::toArray() — Method in class Toc

Output the navigation data

_

Item::__construct() — Method in class Item
Constructor
Item::__toString() — Method in class Item

Implement Stringable

Toc::__construct() — Method in class Toc
Constructor
Toc::__toString() — Method in class Toc

Implement Stringable Interface

MarkdownString::__construct() — Method in class MarkdownString
Constructor
MarkdownString::__toString() — Method in class MarkdownString

Implements Stringable interface