Korin API

Dialects
in package

FinalYes

Documented mistakes of programs, which a reader corrects to read their files as they are (SPEC section 3; docs/dialects.md). Each is reported (KV1010) and none changes a line: it only decides the encoding or version the file is read in. {@see \Korin\Gedcom\ReadOptions::withDialects()} turns them off.

Table of Contents

Methods

encoding()  : Encoding, string}|null
The encoding of a file whose CHAR a program is known to get wrong, when the content is not ASCII (or UTF-8, which wins anyway); null when no mistake applies.
version()  : Version, string}|null
The version of a file whose program declares another; null when no mistake applies.

Methods

encoding()

The encoding of a file whose CHAR a program is known to get wrong, when the content is not ASCII (or UTF-8, which wins anyway); null when no mistake applies.

public static encoding(Encoding|null $declared, string|null $charVersion, Program|null $program, string|null $programVersion) : Encoding, string}|null
Parameters
$declared : Encoding|null
$charVersion : string|null
$program : Program|null
$programVersion : string|null
Return values
Encoding, string}|null —

the encoding and the message of KV1010

version()

The version of a file whose program declares another; null when no mistake applies.

public static version(Node $head, Version $declared) : Version, string}|null
Parameters
$head : Node
$declared : Version
Return values
Version, string}|null —

the version and the message of KV1010

On this page

Search results