GenIndexTermData
in package
FinalYes
All rows collected for a single genindex term or subterm, before it's turned into a rendered {@see \phpDocumentor\Guides\Nodes\Index\GenIndexTerm} node. Only ever nested one level deep in practice (a subterm's own `subterms` stays empty), the same convention `GenIndexTerm` itself follows.
Table of Contents
Properties
Methods
- __construct() : mixed
- addRow() : void
- getOrCreateSubterm() : self
- getRows() : GenIndexRowData[]
- getSubterms() : array<string, GenIndexTermData>
- getTerm() : string
Properties
$rows
private
array
$rows
= []
$subterms
private
array
$subterms
= []
$term read-only
private
string
$term
Methods
__construct()
public
__construct(string $term[, GenIndexRowData[] $rows = [] ][, array<string, GenIndexTermData> $subterms = [] ]) : mixed
Parameters
- $term : string
- $rows : GenIndexRowData[] = []
- $subterms : array<string, GenIndexTermData> = []
addRow()
public
addRow(GenIndexRowData $row) : void
Parameters
- $row : GenIndexRowData
getOrCreateSubterm()
public
getOrCreateSubterm(string $key, string $term) : self
Parameters
- $key : string
- $term : string
Return values
selfgetRows()
public
getRows() : GenIndexRowData[]
Return values
GenIndexRowData[]getSubterms()
public
getSubterms() : array<string, GenIndexTermData>
Return values
array<string, GenIndexTermData>getTerm()
public
getTerm() : string