Archive
in package
A GEDZIP archive that was read ({@see \Korin\Gedcom\Gedcom::readGedzip()}): its gedcom.ged as a document, and its media, read from the archive when asked for, never extracted to disk.
Entries with unsafe names and symbolic links are ignored (KV1201, KV1202).
Table of Contents
Methods
- __construct() : mixed
- diagnostics() : array<int, Diagnostic>
- document() : Document
- entries() : array<int, string>
- has() : bool
- Whether a FILE reference ("photos/anna%20k.jpg") names an entry.
- ignored() : array<int, string>
- media() : resource
- The content of the entry a FILE reference names, as a stream decompressed as it is read.
- missing() : array<int, string>
Methods
__construct()
public
__construct(ZipArchive $zip, Document $document, array<int, string> $entries, array<int, string> $ignored, array<int, string> $missing, array<int, Diagnostic> $diagnostics) : mixed
Parameters
- $zip : ZipArchive
- $document : Document
- $entries : array<int, string>
-
safe entries, in order, gedcom.ged and directories left out
- $ignored : array<int, string>
-
entries that are not used
- $missing : array<int, string>
-
relative FILE references without an entry, in document order
- $diagnostics : array<int, Diagnostic>
-
of the archive: KV1201–KV1204
diagnostics()
public
diagnostics() : array<int, Diagnostic>
Return values
array<int, Diagnostic> —of the archive; the document has those of its lines
document()
public
document() : Document
Return values
Documententries()
public
entries() : array<int, string>
Return values
array<int, string> —the media entries: every safe entry but gedcom.ged, in order
has()
Whether a FILE reference ("photos/anna%20k.jpg") names an entry.
public
has(string $reference) : bool
Parameters
- $reference : string
Return values
boolignored()
public
ignored() : array<int, string>
Return values
array<int, string> —entries that are not used: unsafe names (zip-slip) and symbolic links
media()
The content of the entry a FILE reference names, as a stream decompressed as it is read.
public
media(string $reference) : resource
Parameters
- $reference : string
Tags
Return values
resourcemissing()
public
missing() : array<int, string>
Return values
array<int, string> —FILE references that are relative paths and name no entry