Korin API

Records
in

The records a validation goes through, one after another, and those it looks up by xref: of a document, or of an indexed file, where each record is a document of its own. A record is known by a key that grows with its place in the file.

Table of Contents

Methods

all()  : iterable<int, Document, int}>
diagnostics()  : array<int, Diagnostic>
find()  : int|null
Key of the first record with this xref (in order; lines that are not GEDCOM lines have none).
get()  : Document, int}
hasBom()  : bool
line()  : int
1-based line of the record; 0 for one added after reading.
tag()  : string
version()  : Version

Methods

all()

public all() : iterable<int, Document, int}>
Return values
iterable<int, Document, int}> —

key => the record's document and node, in order

diagnostics()

public diagnostics() : array<int, Diagnostic>
Return values
array<int, Diagnostic> —

the syntax diagnostics of reading; of an indexed file those of the records gone through

find()

Key of the first record with this xref (in order; lines that are not GEDCOM lines have none).

public find(string $xref) : int|null
Parameters
$xref : string
Return values
int|null

get()

public get(int $key) : Document, int}
Parameters
$key : int
Return values
Document, int} —

the record's document and node

hasBom()

public hasBom() : bool
Return values
bool

line()

1-based line of the record; 0 for one added after reading.

public line(int $key) : int
Parameters
$key : int
Return values
int

tag()

public tag(int $key) : string
Parameters
$key : int
Return values
string
On this page

Search results