Repository
extends RecordView
in package
FinalYes
A live view of a REPO record: an archive or library that holds sources.
Table of Contents
Constants
Properties
- $file : Document|IndexedDocument|null
- $node : Node
Methods
- __construct() : mixed
- addEvent() : Event
- Adds an event of the record type; one without a date or place is "Y", it happened. The tree is not changed when the date cannot be written in the version.
- address() : string|null
- ADDR, the lines of the address joined with "\n".
- name() : string|null
- node() : Node
- of() : self|null
- setName() : self
- tagIn() : string
- The tag of the record type in a version.
- typed() : T|null
- xref() : string|null
- eventsOf() : array<int, Event>
- lookUp() : Node|null
- The record of a pointer, or null when there is none of that type.
- pointers() : array<int, string>
- setText() : static
- Replaces the value of the first substructure with this tag, adds one, or removes it for null.
- text() : string|null
- The value of the first substructure with this tag.
- version() : Version
Constants
EVENTS
public
array<string, true>
EVENTS
= []
events of the record type, by tag
TAG
public
string
TAG
= 'REPO'
the record's tag; see self::tagIn()
Properties
$file read-only
protected
Document|IndexedDocument|null
$file
$node read-only
protected
Node
$node
Methods
__construct()
public
__construct(Node $node, Document|IndexedDocument|null $file) : mixed
Parameters
- $node : Node
- $file : Document|IndexedDocument|null
-
where the records it points to are; null for a streamed record
addEvent()
Adds an event of the record type; one without a date or place is "Y", it happened. The tree is not changed when the date cannot be written in the version.
public
addEvent(string $tag[, GedcomDate|null $date = null ][, Place|null $place = null ]) : Event
Parameters
- $tag : string
- $date : GedcomDate|null = null
- $place : Place|null = null
Tags
Return values
Eventaddress()
ADDR, the lines of the address joined with "\n".
public
address() : string|null
Return values
string|nullname()
public
name() : string|null
Return values
string|nullnode()
public
node() : Node
Return values
Nodeof()
public
static of(Node $node, Document|IndexedDocument|null $file) : self|null
Parameters
- $node : Node
- $file : Document|IndexedDocument|null
Return values
self|nullsetName()
public
setName(string|null $name) : self
Parameters
- $name : string|null
Return values
selftagIn()
The tag of the record type in a version.
public
static tagIn(Version $version) : string
Parameters
- $version : Version
Return values
stringtyped()
public
static typed(Node|null $record, Document|IndexedDocument|null $file, T> $class) : T|null
Parameters
- $record : Node|null
- $file : Document|IndexedDocument|null
- $class : T>
Tags
Return values
T|nullxref()
public
xref() : string|null
Return values
string|nulleventsOf()
protected
eventsOf(array<string, true> $tags) : array<int, Event>
Parameters
- $tags : array<string, true>
Return values
array<int, Event> —the events with these tags, in order
lookUp()
The record of a pointer, or null when there is none of that type.
protected
lookUp(string $xref, string $tag) : Node|null
Parameters
- $xref : string
- $tag : string
Return values
Node|nullpointers()
protected
pointers(string $tag) : array<int, string>
Parameters
- $tag : string
Return values
array<int, string> —the pointers of these substructures, null pointers left out
setText()
Replaces the value of the first substructure with this tag, adds one, or removes it for null.
protected
setText(string $tag, string|null $value) : static
Parameters
- $tag : string
- $value : string|null
Return values
statictext()
The value of the first substructure with this tag.
protected
text(string $tag) : string|null
Parameters
- $tag : string
Return values
string|nullversion()
protected
version() : Version