Korin API

Translations
in package
implements NodeRule

FinalYes

FONE and ROMN, the phonetic and romanized variations of a name or place, become TRAN with a BCP 47 LANG in place of their TYPE: the types 5.5.1 names map to a language and script (hangul → ko-Hang, kana → ja-Kana, romaji → ja-Latn, pinyin → zh-Latn-pinyin, wadegiles → zh-Latn-wadegile; a FONE type only for FONE, a ROMN type only for ROMN); any other type keeps its value as _TYPE, with LANG und (FONE) or und-Latn (ROMN, a romanization is in Latin script). An empty TYPE is dropped.

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