Guides

TocProject
in package
implements JsonSerializable

FinalYes

What "toc.json" says about the manual itself, once: its title and version, and whatever a theme adds with {@see TocProject::setExtra()}.

Table of Contents

Interfaces

JsonSerializable

Properties

$extra  : array<string, mixed>
$title  : string
$version  : string

Methods

__construct()  : mixed
getExtra()  : array<string, mixed>
getTitle()  : string
getVersion()  : string
jsonSerialize()  : array<string, mixed>
setExtra()  : self
setTitle()  : self
setVersion()  : self

Properties

Methods

__construct()

public __construct(string $title, string $version) : mixed
Parameters
$title : string
$version : string

getExtra()

public getExtra() : array<string, mixed>
Return values
array<string, mixed>

getTitle()

public getTitle() : string
Return values
string

getVersion()

public getVersion() : string
Return values
string

jsonSerialize()

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

setExtra()

public setExtra(string $key, mixed $value) : self
Parameters
$key : string
$value : mixed
Return values
self

setTitle()

public setTitle(string $title) : self
Parameters
$title : string
Return values
self

setVersion()

public setVersion(string $version) : self
Parameters
$version : string
Return values
self
On this page

Search results