GenIndexRowData
in package
FinalYes
One collected genindex row, before it's turned into a rendered {@see \phpDocumentor\Guides\Nodes\Index\GenIndexRow} node: either a direct link to a section, or a "see"/"seealso" cross-reference to another term.
Table of Contents
Properties
- $anchor : string|null
- $filePath : string
- Path of the document the entry was written in, used for `:scope:` filtering.
- $kind : GenIndexRowKind
- $main : bool
- $seeText : string|null
- The literal term text a "see"/"seealso" row points at.
- $title : string|null
Methods
- __construct() : mixed
- withAnchor() : self
- A "see"/"seealso" row resolved to point at its target's anchor.
Properties
$anchor read-only
public
string|null
$anchor
$filePath read-only
Path of the document the entry was written in, used for `:scope:` filtering.
public
string
$filePath
$kind read-only
public
GenIndexRowKind
$kind
$main read-only
public
bool
$main
$seeText read-only
The literal term text a "see"/"seealso" row points at.
public
string|null
$seeText
$title read-only
public
string|null
$title
Methods
__construct()
public
__construct(GenIndexRowKind $kind, bool $main, string|null $anchor, string|null $title, string|null $seeText, string $filePath) : mixed
Parameters
- $kind : GenIndexRowKind
- $main : bool
- $anchor : string|null
- $title : string|null
- $seeText : string|null
- $filePath : string
withAnchor()
A "see"/"seealso" row resolved to point at its target's anchor.
public
withAnchor(string|null $anchor) : self
Parameters
- $anchor : string|null