GenIndexTermMap
in package
implements
IteratorAggregate
FinalYes
Every genindex term collected project-wide, keyed by its normalized term text. Passed between {@see IndexEntryCollector}, {@see GenIndexSeeResolver}, {@see GenIndexTermMapFilter} and {@see GenIndexNodeBuilder} as they collect, resolve, scope and render it in turn.
Table of Contents
Interfaces
- IteratorAggregate
Properties
- $terms : array<string, GenIndexTermData>
Methods
- get() : GenIndexTermData|null
- getIterator() : Traversable<string, GenIndexTermData>
- getOrCreateTerm() : GenIndexTermData
- isEmpty() : bool
- set() : void
Properties
$terms
private
array<string, GenIndexTermData>
$terms
= []
Methods
get()
public
get(string $key) : GenIndexTermData|null
Parameters
- $key : string
Return values
GenIndexTermData|nullgetIterator()
public
getIterator() : Traversable<string, GenIndexTermData>
Return values
Traversable<string, GenIndexTermData>getOrCreateTerm()
public
getOrCreateTerm(string $key, string $term) : GenIndexTermData
Parameters
- $key : string
- $term : string
Return values
GenIndexTermDataisEmpty()
public
isEmpty() : bool
Return values
boolset()
public
set(string $key, GenIndexTermData $term) : void
Parameters
- $key : string
- $term : GenIndexTermData