Korin API

Translations
in package
implements NodeRule

FinalYes

TRAN of a name or place in a language and script 5.5.1 has a variation type for becomes its phonetic or romanized variation, LANG becoming TYPE: ko-Hang → FONE hangul, ja-Kana → FONE kana, ja-Latn → ROMN romaji, zh-Latn-pinyin → ROMN pinyin, zh-Latn-wadegile → ROMN wadegiles; LANG und and und-Latn, which converting up writes for another type, become FONE and ROMN with that type (_TYPE). Any other TRAN is left to the structures rule (_TRAN).

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