Korin API

GedzipWriter
in package

Read onlyYes
FinalYes

Writes a GEDZIP archive: the document as gedcom.ged, first, and the media under the names its FILE references use. The archive is written to a temporary file next to the target and renamed when complete, so a failure leaves no half-written archive.

Table of Contents

Methods

__construct()  : mixed
write()  : void

Methods

write()

public write(Document $document, string $path[, array<string|int, string|resource> $media = [] ][, WriteOptions $options = new WriteOptions() ]) : void
Parameters
$document : Document
$path : string
$media : array<string|int, string|resource> = []

entry name => a file to add, or a stream read from its position (a name of digits is an integer key)

$options : WriteOptions = new WriteOptions()
Tags
throws
GedzipException

for a document that is not 7.0, an unsafe entry name, or a file that cannot be written

On this page

Search results