Korin API

SourceLines
in package
implements Rule

FinalYes

The first rule of every conversion, for what the reader could not read cleanly:

  • lines that are not GEDCOM lines (KV1001) have no place in any version, whatever the loss policy: they are dropped and reported (KL1001); empty lines carry no data and are dropped silently;
  • bytes invalid in the source encoding (KV1003) were decoded as U+FFFD, which the output keeps; the line is reported (KL1002).

Table of Contents

Interfaces

Rule
One conversion rule. It changes one record at a time, so that a conversion can stream: what it must know about the whole input comes from the Prepass, which runs only when a rule needs it.

Methods

needsPrepass()  : bool
Whether the rule needs Context::prepass(): facts about the whole input before the first record.
record()  : void
Converts one record (HEAD and TRLR included) of the document in place.

Methods

needsPrepass()

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

public needsPrepass() : bool
Return values
bool

record()

Converts one record (HEAD and TRLR included) of the document in place.

public record(Document $document, int $record, Context $context) : void
Parameters
$document : Document
$record : int
$context : Context
On this page

Search results