Record
in package
Read onlyYes
FinalYes
One record of a {@see RecordStream}: a document of its own whose only record it is, so nothing else of the file is in memory. Lines keep the numbers they have in the file; writing the document in preserve mode gives the record's original bytes (the first record of a file with a BOM starts with it).
Table of Contents
Methods
- __construct() : mixed
- document() : Document
- line() : int
- 1-based line of the record in the file.
- node() : Node
- tag() : string
- Empty for a line before the first record that is not a GEDCOM line.
- view() : RecordView|null
- The view of an INDI or FAM record, null for other records. It is limited to the record: what needs another one throws {@see \Korin\Gedcom\Exception\RequiresDocumentException}, pointers ({@see Individual::familyXrefs()}) do not.
- xref() : string|null
Methods
__construct()
public
__construct(Document $document) : mixed
Parameters
- $document : Document
document()
public
document() : Document
Return values
Documentline()
1-based line of the record in the file.
public
line() : int
Return values
intnode()
public
node() : Node
Return values
Nodetag()
Empty for a line before the first record that is not a GEDCOM line.
public
tag() : string
Return values
stringview()
The view of an INDI or FAM record, null for other records. It is limited to the record: what needs another one throws {@see \Korin\Gedcom\Exception\RequiresDocumentException}, pointers ({@see Individual::familyXrefs()}) do not.
public
view() : RecordView|null
Return values
RecordView|nullxref()
public
xref() : string|null