PHP Класс Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\Processor

Наследование: implements League\CommonMark\DocumentProcessorInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$config

Открытые методы

Метод Описание
__construct ( Config $config )
generate ( Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\Entry[] $headings ) : Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\RootEntry Make a tree of the list of headings
hasAutoTOC ( )
processDocument ( Document $document ) : void

Защищенные методы

Метод Описание
cloneChildren ( Heading $node ) : League\CommonMark\Node\Node[]
ensureHeadingHasId ( Heading $node )
render ( array $entries ) : League\CommonMark\Block\Element\ListBlock
setNull ( Heading $object, string $property ) Set the specified property to null on the object.

Описание методов

__construct() публичный Метод

public __construct ( Config $config )
$config Todaymade\Daux\Config

cloneChildren() защищенный Метод

protected cloneChildren ( Heading $node ) : League\CommonMark\Node\Node[]
$node League\CommonMark\Block\Element\Heading
Результат League\CommonMark\Node\Node[]

ensureHeadingHasId() защищенный Метод

protected ensureHeadingHasId ( Heading $node )
$node League\CommonMark\Block\Element\Heading

generate() публичный Метод

Make a tree of the list of headings
public generate ( Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\Entry[] $headings ) : Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\RootEntry
$headings Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\Entry[]
Результат Todaymade\Daux\Format\HTML\ContentTypes\Markdown\TOC\RootEntry

hasAutoTOC() публичный Метод

public hasAutoTOC ( )

processDocument() публичный Метод

public processDocument ( Document $document ) : void
$document League\CommonMark\Block\Element\Document
Результат void

render() защищенный Метод

protected render ( array $entries ) : League\CommonMark\Block\Element\ListBlock
$entries array
Результат League\CommonMark\Block\Element\ListBlock

setNull() защищенный Метод

Set the specified property to null on the object.
protected setNull ( Heading $object, string $property )
$object League\CommonMark\Block\Element\Heading The object to modify
$property string The property to nullify

Описание свойств

$config защищенное свойство

protected $config