TocTree 

namespace	bhenk\doc2rst\rst
predicates	Cloneable \| Instantiable
implements	Stringable

Constructor 

TocTree::__construct 

predicates

public | constructor

public function __construct(
      Parameter #0 [ <optional> array $entries = [] ]
 )

param array $entries

Methods 

TocTree::isEmpty 

predicates

public

public function isEmpty(): bool

return bool

TocTree::__toString 

predicates	public
implements	Stringable::__toString

public function __toString(): string

return string

TocTree::addEntry 

predicates

public

public function addEntry(
      Parameter #0 [ <required> string $link ]
      Parameter #1 [ <optional> ?string $title = NULL ]
 ): void

param string $link
param ?string $title
return void

TocTree::getEntries 

predicates

public

public function getEntries(): array

return array

TocTree::setEntries 

predicates

public

public function setEntries(
      Parameter #0 [ <required> array $entries ]
 ): void

param array $entries

return void

TocTree::getMaxDepth 

predicates

public

public function getMaxDepth(): int

return int

TocTree::setMaxDepth 

predicates

public

public function setMaxDepth(
      Parameter #0 [ <required> int $max_depth ]
 ): void

param int $max_depth

return void

TocTree::getCaption 

predicates

public

public function getCaption(): ?string

return ?string

TocTree::setCaption 

predicates

public

public function setCaption(
      Parameter #0 [ <required> ?string $caption ]
 ): void

param ?string $caption

return void

TocTree::getName 

predicates

public

public function getName(): ?string

return ?string

TocTree::setName 

predicates

public

public function setName(
      Parameter #0 [ <required> ?string $name ]
 ): void

param ?string $name

return void

TocTree::isTitlesOnly 

predicates

public

public function isTitlesOnly(): bool

return bool

TocTree::setTitlesOnly 

predicates

public

public function setTitlesOnly(
      Parameter #0 [ <required> bool $titles_only ]
 ): void

param bool $titles_only

return void

Fri, 31 Mar 2023 13:22:46 +0000