GenIndexTermMapFilter
in package
FinalYes
Restricts a (already see-resolved) term map to rows originating from a document under one of a set of path prefixes -- used for a `.. genindex::` directive's `:scope:` option.
Table of Contents
Methods
- filterTermMap() : GenIndexTermMap
- Drops any term or subterm left with no rows and no surviving subterms of its own. `see`/`seealso` rows are filtered by where the entry itself was written, not by what it resolves to -- a target found outside the visible scope still links correctly, it just isn't itself listed as a separate row here.
- filterRowsByPath() : GenIndexRowData[]
Methods
filterTermMap()
Drops any term or subterm left with no rows and no surviving subterms of its own. `see`/`seealso` rows are filtered by where the entry itself was written, not by what it resolves to -- a target found outside the visible scope still links correctly, it just isn't itself listed as a separate row here.
public
filterTermMap(GenIndexTermMap $termMap, string[] $pathPrefixes) : GenIndexTermMap
Parameters
- $termMap : GenIndexTermMap
- $pathPrefixes : string[]
Return values
GenIndexTermMapfilterRowsByPath()
private
filterRowsByPath(GenIndexRowData[] $rows, string[] $pathPrefixes) : GenIndexRowData[]
Parameters
- $rows : GenIndexRowData[]
- $pathPrefixes : string[]