Korin API

Identifiers
in package
implements NodeRule

FinalYes

AFN, RFN and RIN become EXID with the TYPE the 7.0 term files define for the conversion:

  • AFN x → EXID x, TYPE https://gedcom.io/terms/v7/AFN;
  • RFN xyz:123abc → EXID xyz, TYPE https://gedcom.io/terms/v7/RFN#123abc (the term file's recommended conversion), RFN x without ":" → EXID x, TYPE https://gedcom.io/terms/v7/RFN;
  • RIN x in a file whose HEAD.SOUR is XYZ → EXID x, TYPE https://gedcom.io/terms/v7/RIN#XYZ, without the fragment when there is no HEAD.SOUR.

Fragments are percent-encoded. Substructures of extensions are left alone.

Table of Contents

Interfaces

NodeRule
A rule for one structure at a time. Rules that look at every line of a record are grouped in {@see Rule\Nodes}, which walks each record once for all of them.

Methods

needsPrepass()  : bool
Whether the rule needs Context::prepass(): facts about the whole input before the first record.
node()  : bool
Converts one structure (a record or a substructure; never a CONC/CONT line) with one of the rule's tags, as the structure is tagged when the walk reaches it, in place. Its substructures are visited after it, as they are when this returns.
tags()  : array<int, string>|null

Methods

needsPrepass()

Whether the rule needs Context::prepass(): facts about the whole input before the first record.

public needsPrepass() : bool
Return values
bool

node()

Converts one structure (a record or a substructure; never a CONC/CONT line) with one of the rule's tags, as the structure is tagged when the walk reaches it, in place. Its substructures are visited after it, as they are when this returns.

public node(Document $document, int $id, Context $context) : bool
Parameters
$document : Document
$id : int
$context : Context
Return values
bool —

false when the rule removed the structure: the rules after it and its substructures are skipped

tags()

public tags() : array<int, string>|null
Return values
array<int, string>|null —

the tags of the structures the rule converts; null for every structure

On this page

Search results