Korin API

Rule
in

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.

Table of Contents

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