Korin API

Event
in package

Read onlyYes
FinalYes

A live view of an event of an individual or a family (BIRT, MARR, EVEN …): its date, place, age and type. Dates and ages are read and written by the rules of the document's version: in 7.0 their phrase is the PHRASE substructure, in 5.x part of the value.

Table of Contents

Methods

__construct()  : mixed
age()  : Age|null
AGE of an individual's event; null without one or with one that is not a valid age of the version.
date()  : GedcomDate|null
Null without a DATE, or with one that is not a valid date of the version (its text is on {@see node()}).
node()  : Node
place()  : Place|null
setAge()  : self
setDate()  : self
Replaces the DATE, its phrase included; null removes it.
setPlace()  : self
tag()  : string
type()  : string|null
TYPE: what kind of event an EVEN is, or a detail of another one.

Methods

__construct()

public __construct(Node $node) : mixed
Parameters
$node : Node

age()

AGE of an individual's event; null without one or with one that is not a valid age of the version.

public age() : Age|null
Return values
Age|null

date()

Null without a DATE, or with one that is not a valid date of the version (its text is on {@see node()}).

public date() : GedcomDate|null
Return values
GedcomDate|null

setAge()

public setAge(Age|null $age) : self
Parameters
$age : Age|null
Tags
throws
InvalidValueException

when the version cannot write the age; 5.x has no phrase of an age

Return values
self

setDate()

Replaces the DATE, its phrase included; null removes it.

public setDate(GedcomDate|null $date) : self
Parameters
$date : GedcomDate|null
Tags
throws
InvalidValueException

when the version cannot write the date

Return values
self

setPlace()

public setPlace(Place|null $place) : self
Parameters
$place : Place|null
Return values
self

tag()

public tag() : string
Return values
string

type()

TYPE: what kind of event an EVEN is, or a detail of another one.

public type() : string|null
Return values
string|null
On this page

Search results