gedcomx-php
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • Conclusion
  • DateInfo
  • DisplayProperties
  • Document
  • Event
  • EventRole
  • Fact
  • Gender
  • Identifier
  • Name
  • NameForm
  • NamePart
  • Person
  • PlaceDescription
  • PlaceDisplayProperties
  • PlaceReference
  • Relationship
  • Subject

Interfaces

  • HasFacts

Class DisplayProperties

A set of display properties for the convenience of quick display, such as for a Web-based application. All display properties are provided in the default locale for the current application context and are NOT considered canonical for the purposes of data exchange.

Gedcomx\Common\ExtensibleData
Extended by Gedcomx\Conclusion\DisplayProperties
Namespace: Gedcomx\Conclusion
Located at Conclusion/DisplayProperties.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a DisplayProperties from a (parsed) JSON hash

Constructs a DisplayProperties from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.

Throws

Exception

Overrides

Gedcomx\Common\ExtensibleData::__construct
public string
# getAscendancyNumber( )

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

Returns

string
public
# setAscendancyNumber( string $ascendancyNumber )

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

Parameters

$ascendancyNumber
public string
# getBirthDate( )

The displayable label for the birth date of the person.

The displayable label for the birth date of the person.

Returns

string
public
# setBirthDate( string $birthDate )

The displayable label for the birth date of the person.

The displayable label for the birth date of the person.

Parameters

$birthDate
public string
# getBirthPlace( )

The displayable label for the birth place of the person.

The displayable label for the birth place of the person.

Returns

string
public
# setBirthPlace( string $birthPlace )

The displayable label for the birth place of the person.

The displayable label for the birth place of the person.

Parameters

$birthPlace
public string
# getDeathDate( )

The displayable label for the death date of the person.

The displayable label for the death date of the person.

Returns

string
public
# setDeathDate( string $deathDate )

The displayable label for the death date of the person.

The displayable label for the death date of the person.

Parameters

$deathDate
public string
# getDeathPlace( )

The displayable label for the death place of the person.

The displayable label for the death place of the person.

Returns

string
public
# setDeathPlace( string $deathPlace )

The displayable label for the death place of the person.

The displayable label for the death place of the person.

Parameters

$deathPlace
public string
# getDescendancyNumber( )

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

Returns

string
public
# setDescendancyNumber( string $descendancyNumber )

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

Parameters

$descendancyNumber
public string
# getGender( )

The displayable label for the gender of the person.

The displayable label for the gender of the person.

Returns

string
public
# setGender( string $gender )

The displayable label for the gender of the person.

The displayable label for the gender of the person.

Parameters

$gender
public string
# getLifespan( )

The displayable label for the lifespan of the person.

The displayable label for the lifespan of the person.

Returns

string
public
# setLifespan( string $lifespan )

The displayable label for the lifespan of the person.

The displayable label for the lifespan of the person.

Parameters

$lifespan
public string
# getMarriageDate( )

The displayable label for the marriage date of the person.

The displayable label for the marriage date of the person.

Returns

string
public
# setMarriageDate( string $marriageDate )

The displayable label for the marriage date of the person.

The displayable label for the marriage date of the person.

Parameters

$marriageDate
public string
# getMarriagePlace( )

The displayable label for the marriage place of the person.

The displayable label for the marriage place of the person.

Returns

string
public
# setMarriagePlace( string $marriagePlace )

The displayable label for the marriage place of the person.

The displayable label for the marriage place of the person.

Parameters

$marriagePlace
public string
# getName( )

The displayable name of the person.

The displayable name of the person.

Returns

string
public
# setName( string $name )

The displayable name of the person.

The displayable name of the person.

Parameters

$name
public array
# toArray( )

Returns the associative array for this DisplayProperties

Returns the associative array for this DisplayProperties

Returns

array

Overrides

Gedcomx\Common\ExtensibleData::toArray
public
# initFromArray( array $o )

Initializes this DisplayProperties from an associative array

Initializes this DisplayProperties from an associative array

Parameters

$o

Overrides

Gedcomx\Common\ExtensibleData::initFromArray
public
# writeXmlContents( XMLWriter $writer )

Writes the contents of this DisplayProperties to an XML writer. The startElement is expected to be already provided.

Writes the contents of this DisplayProperties to an XML writer. The startElement is expected to be already provided.

Parameters

$writer
The XML writer.

Overrides

Gedcomx\Common\ExtensibleData::writeXmlContents

Methods inherited from Gedcomx\Common\ExtensibleData

addExtensionElement(), findExtensionOfType(), findExtensionsOfType(), getExtensionElements(), getId(), initFromReader(), removeExtensionElements(), setExtensionElement(), setExtensionElements(), setId(), toJson()

gedcomx-php API documentation generated by ApiGen